Skip to main content

ISummaryContext Interface

Context for uploading a summary to storage. Indicates the previously acked summary.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

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

Signature​

export interface ISummaryContext

Properties​

PropertyAlertsModifiersTypeDescription
ackHandleBetareadonlystring | undefinedParent summary acked handle (from summary ack)
proposalHandleBetareadonlystring | undefinedParent summary proposed handle (from summary op)
referenceSequenceNumberBetareadonlynumber

Property Details​

ackHandle​

Parent summary acked handle (from summary ack)

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 ackHandle: string | undefined;

Type: string | undefined

proposalHandle​

Parent summary proposed handle (from summary op)

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 proposalHandle: string | undefined;

Type: string | undefined

referenceSequenceNumber​

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