IBaseSummarizeResult Interface

Base results for all submitSummary attempts.

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 IBaseSummarizeResult

Properties

Property	Alerts	Modifiers	Type	Description
error	Alpha	readonly	IRetriableFailureError | undefined	Retriable error object related to failed summarize attempt.
minimumSequenceNumber	Alpha	readonly	number
referenceSequenceNumber	Alpha	readonly	number	Reference sequence number as of the generate summary attempt.
stage	Alpha	readonly	"base"

Property Details

error

Retriable error object related to failed summarize 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 error: IRetriableFailureError | undefined;

Type: IRetriableFailureError | undefined

minimumSequenceNumber

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

Type: number

referenceSequenceNumber

Reference sequence number as of the generate summary 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 referenceSequenceNumber: number;

Type: number

stage

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 stage: "base";

Type: "base"