Skip to main content

ISubmitSummaryOptions Interface

This API is deprecated and will be removed in a future release.

This type will be moved to internal in 2.30. External usage is not necessary or supported.

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

Properties​

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

Property Details​

cancellationToken​

Tells when summary process should be cancelled

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 cancellationToken: ISummaryCancellationToken;

Type: ISummaryCancellationToken

finalAttempt​

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

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 finalAttempt?: boolean;

Type: boolean

latestSummaryRefSeqNum​

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

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 latestSummaryRefSeqNum: number;

Type: number

summaryLogger​

Logger to use for correlated summary events

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 summaryLogger: ITelemetryLoggerExt;

Type: ITelemetryLoggerExt