ICaptureFullContainerStateProps Interface

Properties for captureFullContainerState({ urlResolver, documentServiceFactory, request, logger, }, input).

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 ICaptureFullContainerStateProps

Properties

Property	Alerts	Modifiers	Type	Description
documentServiceFactory	Alpha	readonly	IDocumentServiceFactory	The document service factory used to construct the driver services against which the state is captured.
logger	Alpha	optional, readonly	ITelemetryBaseLogger | undefined	Optional logger for driver-side telemetry.
request	Alpha	readonly	IRequest	The request identifying the container whose state is to be captured.
urlResolver	Alpha	readonly	IUrlResolver	The url resolver used to resolve the request into a Fluid resolved url.

Property Details

documentServiceFactory

The document service factory used to construct the driver services against which the state is captured.

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 documentServiceFactory: IDocumentServiceFactory;

Type: IDocumentServiceFactory

logger

Optional logger for driver-side telemetry.

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 logger?: ITelemetryBaseLogger | undefined;

Type: ITelemetryBaseLogger | undefined

request

The request identifying the container whose state is to be captured.

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

urlResolver

The url resolver used to resolve the request into a Fluid resolved url.

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 urlResolver: IUrlResolver;

Type: IUrlResolver