Try our conversational search powered by Generative AI!

AI OnAI Off

Class BlobProvider

An abstract provider for binary large objects

Inheritance
System.Object
BlobProvider
FileBlobProvider
NullBlobProvider
Namespace: EPiServer.Framework.Blobs
Assembly: EPiServer.Framework.dll
Version: 10.10.4
Syntax
public abstract class BlobProvider : ProviderBase

Constructors

BlobProvider()

Declaration
protected BlobProvider()

Properties

Name

Gets the name of the blob provider instance

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
System.String

Methods

CreateBlob(Uri, String)

Create a reference to a new blob

Declaration
public abstract Blob CreateBlob(Uri id, string extension)
Parameters
Type Name Description
System.Uri id

The identifier of the container
System.String extension

The extention (such as .png)
Returns
Type Description
Blob

A reference to a blob

Delete(Uri)

Delete a blob or a container

Declaration
public abstract void Delete(Uri id)
Parameters
Type Name Description
System.Uri id

The identifier of a blob or a blob container
Remarks

The Host part of the identifier is the container and the path is the file/blob that is being deleted. If the file is missing it is assumed that the container is being deleted.

GetBlob(Uri)

Get a reference to a blob

Declaration
public abstract Blob GetBlob(Uri id)
Parameters
Type Name Description
System.Uri id

The identifier
Returns
Type Description
Blob

A reference to a blob
Remarks

This method will always return a reference even though the actual blob does not exists

Initialize(String, NameValueCollection)

Declaration
public override void Initialize(string name, NameValueCollection config)
Parameters
Type Name Description
System.String name
System.Collections.Specialized.NameValueCollection config

InitializeAsync()

Override this method if the provider has some time consuming initialization that can be done parallell with other initalization modules.

Declaration
public virtual Task InitializeAsync()
Returns
Type Description
System.Threading.Tasks.Task
Remarks

This method will be called during Initialize(InitializationEngine) and then in InitComplete it will wait for the ongoing task to complete.

Extension Methods