ISummary Interface

A single summary which can be tracked as it goes through its life cycle. The life cycle is: Local to Broadcast to Acked/Nacked.

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

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

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

Signature

export interface ISummary

Property	Alerts	Modifiers	Type	Description
clientId	`Alpha`	`readonly`	string
clientSequenceNumber	`Alpha`	`readonly`	number

Method	Alerts	Return Type	Description
waitAckNack()	`Alpha`	Promise<ISummaryAckMessage \| ISummaryNackMessage>
waitBroadcast()	`Alpha`	Promise<ISummaryOpMessage>

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly clientId: string;

Type: string

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

readonly clientSequenceNumber: number;

Type: number

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;

Return type: Promise<ISummaryAckMessage | ISummaryNackMessage >

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

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

waitBroadcast(): Promise<ISummaryOpMessage>;

Return type: Promise<ISummaryOpMessage >