IDocumentStorageService Interface
Interface to provide access to snapshots saved for a shared object \
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy
.
For more information about our API support guarantees, see here.
Signature
export interface IDocumentStorageService extends Partial<IDisposable>
Extends: Partial<IDisposable>
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
policies | Beta |
optional , readonly |
IDocumentStorageServicePolicies | undefined | Policies implemented/instructed by driver. |
Methods
Method | Alerts | Modifiers | Return Type | Description |
---|---|---|---|---|
createBlob(file) | Beta |
Promise<ICreateBlobResponse> | Creates a blob out of the given buffer | |
downloadSummary(handle) | Beta |
Promise<ISummaryTree> | Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the server has deleted it this call may result in a broken promise. | |
getSnapshot(snapshotFetchOptions) | Beta |
optional |
Promise<ISnapshot> | Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from getSnapshotTree api in that, that API only returns the snapshot tree from the snapshot. |
getSnapshotTree(version, scenarioName) | Beta |
Promise<ISnapshotTree | null> | Returns the snapshot tree. | |
getVersions(versionId, count, scenarioName, fetchSource) | Beta |
Promise<IVersion[]> | Retrieves all versions of the document starting at the specified versionId - or null if from the head | |
readBlob(id) | Beta |
Promise<ArrayBufferLike> | Reads the object with the given ID, returns content in arrayBufferLike | |
uploadSummaryWithContext(summary, context) | Beta |
Promise<string> | Uploads a summary tree to storage using the given context for reference of previous summary handle. The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are referencing from the previously acked summary. Returns the uploaded summary handle. |
Property Details
policies
Policies implemented/instructed by driver.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly policies?: IDocumentStorageServicePolicies | undefined;
Type: IDocumentStorageServicePolicies | undefined
Method Details
createBlob
Creates a blob out of the given buffer
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.