ILoadFrozenContainerFromPendingStateProps Interface

Properties required to load a frozen container from pending state. \

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 ILoadFrozenContainerFromPendingStateProps

Properties

Property	Alerts	Modifiers	Type	Description
clientDetailsOverride	Alpha	optional, readonly	IClientDetails | undefined	Client details provided in the override will be merged over the default client.
codeLoader	Alpha	readonly	ICodeDetailsLoader	The code loader handles loading the necessary code for running a container once it is loaded.
configProvider	Alpha	optional, readonly	IConfigProviderBase | undefined	The configuration provider which may be used to control features.
logger	Alpha	optional, readonly	ITelemetryBaseLogger | undefined	The logger that all telemetry should be pushed to.
options	Alpha	optional, readonly	IContainerPolicies | undefined	A property bag of options/policies used by various layers to control features.
pendingLocalState	Alpha	readonly	string	Pending local state to be applied to the container.
request	Alpha	readonly	IRequest	The request to resolve the container.
scope	Alpha	optional, readonly	FluidObject | undefined	Scope is provided to all container and is a set of shared services for container's to integrate with their host environment.
urlResolver	Alpha	readonly	IUrlResolver	The url resolver used by the loader for resolving external urls into Fluid urls.

Property Details

clientDetailsOverride

Client details provided in the override will be merged over the default client.

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 clientDetailsOverride?: IClientDetails | undefined;

Type: IClientDetails | undefined

codeLoader

The code loader handles loading the necessary code for running a container once it is loaded.

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 codeLoader: ICodeDetailsLoader;

Type: ICodeDetailsLoader

configProvider

The configuration provider which may be used to control features.

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 configProvider?: IConfigProviderBase | undefined;

Type: IConfigProviderBase | undefined

logger

The logger that all telemetry should be pushed to.

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

options

A property bag of options/policies used by various layers to control features.

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 options?: IContainerPolicies | undefined;

Type: IContainerPolicies | undefined

pendingLocalState

Pending local state to be applied to 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 pendingLocalState: string;

Type: string

request

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

Type: IRequest

scope

Scope is provided to all container and is a set of shared services for container's to integrate with their host environment.

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 scope?: FluidObject | undefined;

Type: FluidObject | undefined

urlResolver

The url resolver used by the loader for resolving external urls into Fluid urls.

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