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
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| clientId | Beta | readonly | string | |
| clientSequenceNumber | Beta | readonly | number |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| waitAckNack() | Beta | Promise<ISummaryAckMessage | ISummaryNackMessage> | |
| waitBroadcast() | Beta | Promise<ISummaryOpMessage> |
Property Details
clientId
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 clientId: string;
Type: string
clientSequenceNumber
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 clientSequenceNumber: number;
Type: number
Method Details
waitAckNack
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
waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;
Returns
Return type: Promise<ISummaryAckMessage | ISummaryNackMessage>
waitBroadcast
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
waitBroadcast(): Promise<ISummaryOpMessage>;
Returns
Return type: Promise<ISummaryOpMessage>