SnapshotStorage Class
Signature
export declare class SnapshotStorage extends ReadDocumentStorageServiceBase
Extends: ReadDocumentStorageServiceBase
Constructors
| Constructor | Description |
|---|---|
| (constructor)(storage, docTree) | Constructs a new instance of the SnapshotStorage class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| docId | optional |
string | |
| docTree | ISnapshotTree | null | ||
| storage | IDocumentStorageService |
Methods
| Method | Return Type | Description |
|---|---|---|
| getSnapshotTree(versionRequested) | Promise<ISnapshotTree | null> | |
| getVersions(versionId, count) | Promise<IVersion[]> | |
| readBlob(blobId) | Promise<ArrayBufferLike> |
Constructor Details
(constructor)
Constructs a new instance of the SnapshotStorage class
Signature
constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
Parameters
| Parameter | Type | Description |
|---|---|---|
| storage | IDocumentStorageService | |
| docTree | ISnapshotTree | null |
Property Details
docId
Signature
protected docId?: string;
Type: string
docTree
Signature
protected readonly docTree: ISnapshotTree | null;
Type: ISnapshotTree | null
storage
Signature
protected readonly storage: IDocumentStorageService;
Type: IDocumentStorageService
Method Details
getSnapshotTree
Signature
getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| versionRequested | optional | IVersion |
Returns
Return type: Promise<ISnapshotTree | null>
getVersions
Signature
getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| versionId | string | null | |
| count | number |
Returns
Return type: Promise<IVersion[]>
readBlob
Signature
readBlob(blobId: string): Promise<ArrayBufferLike>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| blobId | string |
Returns
Return type: Promise<ArrayBufferLike>