ISubmitSummaryOptions 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 ISubmitSummaryOptions extends ISummarizeOptions

Extends: ISummarizeOptions

Property	Alerts	Modifiers	Type	Description
cancellationToken	`Alpha`	`readonly`	ISummaryCancellationToken	Tells when summary process should be cancelled
finalAttempt	`Alpha`	`optional`, `readonly`	boolean	Summarization may be attempted multiple times. This tells whether this is the final summarization attempt.
latestSummaryRefSeqNum	`Alpha`	`readonly`	number	The sequence number of the latest summary used to validate if summary state is correct before summarizing
summaryLogger	`Alpha`	`readonly`	ITelemetryLoggerExt	Logger to use for correlated summary events

Tells when summary process should be cancelled

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 .

readonly cancellationToken: ISummaryCancellationToken;

Type: ISummaryCancellationToken

Summarization may be attempted multiple times. This tells whether this is the final summarization attempt.

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 .

readonly finalAttempt?: boolean;

Type: boolean

The sequence number of the latest summary used to validate if summary state is correct before summarizing

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 .

readonly latestSummaryRefSeqNum: number;

Type: number

Logger to use for correlated summary events

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 .

readonly summaryLogger: ITelemetryLoggerExt;

Type: ITelemetryLoggerExt