ReadDocumentStorageServiceBase Class
Partial implementation of IDocumentStorageService
Signature
export declare abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService
Implements: IDocumentStorageService
Properties
| Property | Type | Description |
|---|---|---|
| repositoryUrl | string |
Methods
| Method | Return Type | Description |
|---|---|---|
| createBlob(file) | Promise<api.ICreateBlobResponse> | |
| downloadSummary(handle) | Promise<api.ISummaryTree> | |
| getSnapshotTree(version) | Promise<api.ISnapshotTree | null> | |
| getVersions(versionId, count) | Promise<api.IVersion[]> | |
| readBlob(blobId) | Promise<ArrayBufferLike> | |
| uploadSummaryWithContext(summary, context) | Promise<string> |
Property Details
repositoryUrl
Signature
get repositoryUrl(): string;
Type: string
Method Details
createBlob
Signature
createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| file | ArrayBufferLike |
Returns
Return type: Promise<api.ICreateBlobResponse>
downloadSummary
Signature
downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | api.ISummaryHandle |
Returns
Return type: Promise<api.ISummaryTree>
getSnapshotTree
Signature
abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| version | optional | api.IVersion |
Returns
Return type: Promise<api.ISnapshotTree | null>
getVersions
Signature
abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| versionId | string | null | |
| count | number |
Returns
Return type: Promise<api.IVersion[]>
readBlob
Signature
abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blobId | string |
Returns
Return type: Promise<ArrayBufferLike>
uploadSummaryWithContext
Signature
uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| summary | api.ISummaryTree | |
| context | ISummaryContext |
Returns
Return type: Promise<string>