IBlobManager Interface
Packages > @fluidframework/container-definitions > IBlobManager
Provides access to blobs in storage
Signature:
export interface IBlobManager
Methods
| Method | Description |
|---|---|
| addBlob(blob) | Add one blob's metadata to the local storage of blob metadata |
| createBlob(blob) | Upload a blob to storage |
| getBlob(blobId) | Retrieve the blob data |
| getBlobMetadata() | Get the metadata for all blobs on a document Strip content if it exists |
| loadBlobMetadata(blobs) | Rehydrate a blob manager from a snapshot |
| removeBlob(blobId) | Remove blob from storage |
| updateBlob(blob) | Update blob metadata |
Methods
addBlob
Add one blob’s metadata to the local storage of blob metadata
Signature:
addBlob(blob: IGenericBlob): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blob | IGenericBlob |
Returns:
Promise<void>
createBlob
Upload a blob to storage
Signature:
createBlob(blob: IGenericBlob): Promise<IGenericBlob>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blob | IGenericBlob |
Returns:
Promise<IGenericBlob>
getBlob
Retrieve the blob data
Signature:
getBlob(blobId: string): Promise<IGenericBlob | undefined>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blobId | string |
Returns:
Promise<IGenericBlob | undefined>
getBlobMetadata
Get the metadata for all blobs on a document Strip content if it exists
Signature:
getBlobMetadata(): IGenericBlob[];
Returns:
loadBlobMetadata
Rehydrate a blob manager from a snapshot
Signature:
loadBlobMetadata(blobs: IGenericBlob[]): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blobs | IGenericBlob[] |
Returns:
void
removeBlob
Remove blob from storage
Signature:
removeBlob(blobId: string): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blobId | string |
Returns:
Promise<void>
updateBlob
Update blob metadata
Signature:
updateBlob(blob: IGenericBlob): Promise<void | null>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blob | IGenericBlob |
Returns:
Promise<void | null>