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

Property Alerts Modifiers Type Description
ackHandle Alpha readonly string | undefined Parent summary acked handle (from summary ack)
proposalHandle Alpha readonly string | undefined Parent summary proposed handle (from summary op)
referenceSequenceNumber Alpha readonly number

Property Details

ackHandle

Parent summary acked handle (from summary ack)

This API is provided as an alpha preview and may change without notice.

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

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 as an alpha preview and may change without notice.

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

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

Signature

readonly proposalHandle: string | undefined;

Type: string | undefined

referenceSequenceNumber

This API is provided as an alpha preview and may change without notice.

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

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

Signature

readonly referenceSequenceNumber: number;

Type: number