ISummarizerInternalsProvider Interface
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 ISummarizerInternalsProvider
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| refreshLatestSummaryAck(options) | Alpha |
Promise<void> | Callback whenever a new SummaryAck is received, to update internal tracking state |
| submitSummary(options) | Alpha |
Promise<SubmitSummaryResult> | Encapsulates the work to walk the internals of the running container to generate a summary |
Method Details
refreshLatestSummaryAck
Callback whenever a new SummaryAck is received, to update internal tracking state
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.
Signature
refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | IRefreshSummaryAckOptions |
Returns
Return type: Promise<void>
submitSummary
Encapsulates the work to walk the internals of the running container to generate a summary
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.
Signature
submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | ISubmitSummaryOptions |
Returns
Return type: Promise<SubmitSummaryResult>