Skip to main content

IRefreshSummaryAckOptions Interface

Data required to update internal tracking state after receiving a Summary Ack.

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 IRefreshSummaryAckOptions

Properties​

Property Alerts Modifiers Type Description
ackHandle Alpha readonly string Handle from the summary ack just received
proposalHandle Alpha readonly string | undefined Handle from the ack's summary op.
summaryLogger Alpha readonly ITelemetryLoggerExt Telemetry logger to which telemetry events will be forwarded.
summaryRefSeq Alpha readonly number Reference sequence number from the ack's summary op

Property Details​

ackHandle​

Handle from the summary ack just received

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;

Type: string

proposalHandle​

Handle from the ack's 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

summaryLogger​

Telemetry logger to which telemetry events will be forwarded.

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

summaryRefSeq​

Reference sequence number from the ack's 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 summaryRefSeq: number;

Type: number