Skip to main content
Version: v1

ISummaryHandle Interface

Path to a summary tree object from the last successful summary indicating the summary object hasn't changed since it was uploaded. 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 handle would be: '//'.

Signature​

export interface ISummaryHandle

Properties​

PropertyTypeDescription
handlestringUnique path that identifies the corresponding sub-tree in a previous summary.
handleTypeSummaryTypeNoHandleType of Summary Handle (SummaryType.Handle is not supported).
typeSummaryType.Handle

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