Skip to main content

IGetPendingLocalStateProps Interface

Defines list of properties expected for getPendingLocalState

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

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

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

Signature​

export interface IGetPendingLocalStateProps

Properties​

Property Alerts Modifiers Type Description
notifyImminentClosure Alpha readonly boolean Indicates the container will close after getting the pending state. Used internally to wait for blobs to be attached to a DDS and collect generated ops before closing.
sessionExpiryTimerStarted Alpha optional, readonly number Date to be used as the starting time of a session. This date is updated in case we refresh the base snapshot since we won't be referencing ops older than the new snapshot.
snapshotSequenceNumber Alpha optional, readonly number Snapshot sequence number. It will help the runtime to know which ops should still be stashed.
stopBlobAttachingSignal Alpha optional, readonly AbortSignal Abort signal to stop waiting for blobs to get attached to a DDS. When triggered, only blobs attached will be collected in the pending state. Intended to be used in the very rare scenario in which getLocalPendingState go stale due to a blob failed to be referenced. Such a blob will be lost but the rest of the state will be preserved and collected.

Property Details​

notifyImminentClosure​

Indicates the container will close after getting the pending state. Used internally to wait for blobs to be attached to a DDS and collect generated ops before closing.

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 notifyImminentClosure: boolean;

Type: boolean

sessionExpiryTimerStarted​

Date to be used as the starting time of a session. This date is updated in case we refresh the base snapshot since we won't be referencing ops older than the new snapshot.

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 sessionExpiryTimerStarted?: number;

Type: number

snapshotSequenceNumber​

Snapshot sequence number. It will help the runtime to know which ops should still be stashed.

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 snapshotSequenceNumber?: number;

Type: number

stopBlobAttachingSignal​

Abort signal to stop waiting for blobs to get attached to a DDS. When triggered, only blobs attached will be collected in the pending state. Intended to be used in the very rare scenario in which getLocalPendingState go stale due to a blob failed to be referenced. Such a blob will be lost but the rest of the state will be preserved and collected.

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 stopBlobAttachingSignal?: AbortSignal;

Type: AbortSignal