DocumentStorageServiceProxy Class

Signature

export declare class DocumentStorageServiceProxy implements IDocumentStorageService

Implements: IDocumentStorageService

Constructors

Constructor	Description
(constructor)(internalStorageService)	Constructs a new instance of the DocumentStorageServiceProxy class

Properties

Property	Type	Description
internalStorageService	IDocumentStorageService
policies	IDocumentStorageServicePolicies | undefined
repositoryUrl	string

Methods

Method	Return Type	Description
createBlob(file)	Promise<ICreateBlobResponse>
downloadSummary(handle)	Promise<ISummaryTree>
getSnapshotTree(version, scenarioName)	Promise<ISnapshotTree | null>
getVersions(versionId, count, scenarioName)	Promise<IVersion[]>
readBlob(blobId)	Promise<ArrayBufferLike>
uploadSummaryWithContext(summary, context)	Promise<string>

Constructor Details

(constructor)

Constructs a new instance of the DocumentStorageServiceProxy class

Signature

constructor(internalStorageService: IDocumentStorageService);

Parameters

Parameter	Type	Description
internalStorageService	IDocumentStorageService

Property Details

internalStorageService

Signature

protected readonly internalStorageService: IDocumentStorageService;

Type: IDocumentStorageService

policies

Signature

get policies(): IDocumentStorageServicePolicies | undefined;
set policies(policies: IDocumentStorageServicePolicies | undefined);

Type: IDocumentStorageServicePolicies | undefined

repositoryUrl

Signature

get repositoryUrl(): string;

Type: string

Method Details

createBlob

Signature

createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;

Parameters

Parameter	Type	Description
file	ArrayBufferLike

Returns

Return type: Promise<ICreateBlobResponse>

downloadSummary

Signature

downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;

Parameters

Parameter	Type	Description
handle	ISummaryHandle

Returns

Return type: Promise<ISummaryTree>

getSnapshotTree

Signature

getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;

Parameters

Parameter	Modifiers	Type	Description
version	optional	IVersion
scenarioName	optional	string

Returns

Return type: Promise<ISnapshotTree | null>

getVersions

Signature

getVersions(versionId: string | null, count: number, scenarioName?: string): Promise<IVersion[]>;

Parameters

Parameter	Modifiers	Type	Description
versionId		string | null
count		number
scenarioName	optional	string

Returns

Return type: Promise<IVersion[]>

readBlob

Signature

readBlob(blobId: string): Promise<ArrayBufferLike>;

Parameters

Parameter	Type	Description
blobId	string

Returns

Return type: Promise<ArrayBufferLike>

uploadSummaryWithContext

Signature

uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;

Parameters

Parameter	Type	Description
summary	ISummaryTree
context	ISummaryContext

Returns

Return type: Promise<string>