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	Beta	readonly	Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>	Resolves when we receive a summaryAck or summaryNack.
summaryOpBroadcasted	Beta	readonly	Promise<SummarizeResultPart<IBroadcastSummaryResult>>	Resolves when we observe our summarize op broadcast.
summarySubmitted	Beta	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 for existing users, but is not recommended for new users.

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 for existing users, but is not recommended for new users.

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 for existing users, but is not recommended for new users.

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

Signature

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

Type: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>