IRuntimeStorageService Interface

Interface to provide access to snapshot blobs to DataStore layer. \

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IRuntimeStorageService

Properties

Property	Alerts	Modifiers	Type	Description
disposed	Deprecated, Alpha	optional, readonly	boolean	Whether or not the object has been disposed. If true, the object should be considered invalid, and its other state should be disregarded.
policies	Deprecated, Alpha	optional, readonly	IDocumentStorageServicePolicies | undefined

Methods

Method	Alerts	Modifiers	Return Type	Description
createBlob(file)	Deprecated, Alpha		Promise<ICreateBlobResponse>
dispose(error)	Deprecated, Alpha	optional	void	Dispose of the object and its resources.
downloadSummary(handle)	Deprecated, Alpha		Promise<ISummaryTree>
getSnapshot(snapshotFetchOptions)	Deprecated, Alpha	optional	Promise<ISnapshot>
getSnapshotTree(version, scenarioName)	Deprecated, Alpha		Promise<ISnapshotTree | null>
getVersions(versionId, count, scenarioName, fetchSource)	Deprecated, Alpha		Promise<IVersion[]>
readBlob(id)	Alpha		Promise<ArrayBufferLike>	Reads the object with the given ID, returns content in arrayBufferLike
uploadSummaryWithContext(summary, context)	Deprecated, Alpha		Promise<string>

Property Details

disposed

Whether or not the object has been disposed. If true, the object should be considered invalid, and its other state should be disregarded.

This API is deprecated and will be removed in a future release.

• This API is deprecated and will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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 disposed?: boolean;

Type: boolean

policies

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

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

Parameters

Parameter	Type	Description
file	ArrayBufferLike

Returns

Return type: Promise<ICreateBlobResponse>

dispose

Dispose of the object and its resources.

This API is deprecated and will be removed in a future release.

• This API is deprecated and will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

dispose?(error?: Error): void;

Parameters

Parameter	Modifiers	Type	Description
error	optional	Error	Optional error indicating the reason for the disposal, if the object was disposed as the result of an error.

downloadSummary

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

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

Parameters

Parameter	Type	Description
handle	ISummaryHandle

Returns

Return type: Promise<ISummaryTree>

getSnapshot

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;

Parameters

Parameter	Modifiers	Type	Description
snapshotFetchOptions	optional	ISnapshotFetchOptions

Returns

Return type: Promise<ISnapshot>

getSnapshotTree

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

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

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

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

Parameters

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

Returns

Return type: Promise<IVersion[]>

readBlob

Reads the object with the given ID, returns content in arrayBufferLike

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

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

Parameters

Parameter	Type	Description
id	string

Returns

Return type: Promise<ArrayBufferLike>

uploadSummaryWithContext

This API is deprecated and will be removed in a future release.

• This will be removed in a future release. No replacement is planned as it is unused in the DataStore layer.

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

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

Parameters

Parameter	Type	Description
summary	ISummaryTree
context	ISummaryContext

Returns

Return type: Promise<string>