Skip to main content

ISummarizeResults 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 ISummarizeResults

Properties​

Property Alerts Modifiers Type Description
receivedSummaryAckOrNack Alpha readonly Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>> Resolves when we receive a summaryAck or summaryNack.
summaryOpBroadcasted Alpha readonly Promise<SummarizeResultPart<IBroadcastSummaryResult>> Resolves when we observe our summarize op broadcast.
summarySubmitted Alpha readonly Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>> Resolves when we generate, upload, and submit the summary.

Property Details​

receivedSummaryAckOrNack​

Resolves when we receive a summaryAck or summaryNack.

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​

readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;

Type: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>

summaryOpBroadcasted​

Resolves when we observe our summarize op broadcast.

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​

readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;

Type: Promise<SummarizeResultPart<IBroadcastSummaryResult>>

summarySubmitted​

Resolves when we generate, upload, and submit the 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​

readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>;

Type: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>