IClientSummaryWatcher Interface
Watches summaries created by a specific client.
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 IClientSummaryWatcher extends IDisposable
Extends: IDisposable
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| waitFlushed() | Alpha |
Promise<IAckedSummary | undefined> | |
| watchSummary(clientSequenceNumber) | Alpha |
ISummary |
Method Details
waitFlushed
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
waitFlushed(): Promise<IAckedSummary | undefined>;
Returns
Return type: Promise<IAckedSummary | undefined>
watchSummary
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
watchSummary(clientSequenceNumber: number): ISummary;
Parameters
| Parameter | Type | Description |
|---|---|---|
| clientSequenceNumber | number |
Returns
Return type: ISummary