ISummaryHandle Interface

Packages > @fluidframework/driver-definitions > ISummaryHandle

Path to a summary tree object from the last successful summary indicating the summary object hasn’t changed since it was uploaded.

Special characters include ‘/’. ‘/’ is used as a separator between different parts of the path as a way to traverse different nodes in the previous summary/snapshot tree.

Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string causes this path to fail, the id will be invalid.

Signature

export interface ISummaryHandle

Example

To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS. An example of a handle string generated when the DDS did not change would be: ‘/.channels//.channels/’. An example of a handle string generated when the DataStore did not change would be: ‘/.channels/’. An example of a handle string generated when the DDS blob did not change would be: /.channels/<DataStoreId>/.channels/<DDSId>/<BlobId>. An example of a handle string generated when the DataStore .attributes blob did not change would be: /.channels/<DataStoreId>/.attributes.

Properties

Property Details

handle

Unique path that identifies the corresponding sub-tree in a previous summary.

Signature

handle: string;

Type: string

handleType

Type of Summary Handle (SummaryType.Handle is not supported).

Signature

handleType: SummaryTypeNoHandle;

Type: SummaryTypeNoHandle

type

Signature

type: SummaryType.Handle;

Type: SummaryType.Handle