ILoadContainerToSequenceNumberProps Interface

Properties used to materialize a container at a point in document history.

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

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

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

Signature

export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps, IContainerDriverServices

Extends: IContainerHostProps, IContainerDriverServices

Remarks

This is distinct from normal container loading. The supplied documentServiceFactory must be able to materialize the document at loadToSequenceNumber - i.e. it must implement the point-in-time capability the loader detects. For ODSP, pass an IPointInTimeDocumentServiceFactory created by getOdspPointInTimeDocumentServiceFactory.

Properties

Property	Alerts	Modifiers	Type	Description
loadToSequenceNumber	Beta	readonly	number	The sequence number at which to materialize the container.
request	Beta	readonly	IRequest	The request identifying the container instance.
signal	Beta	optional, readonly	AbortSignal | undefined	Cancels replay while waiting for the target sequence number.

Property Details

loadToSequenceNumber

The sequence number at which to materialize the container.

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

Type: number

request

The request identifying the container instance.

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 request: IRequest;

Type: IRequest

signal

Cancels replay while waiting for the target sequence number.

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

Type: AbortSignal | undefined