ICreateAndLoadContainerProps Interface

Properties necessary for creating and loading a container.

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 ICreateAndLoadContainerProps

Properties

Property	Alerts	Modifiers	Type	Description
allowReconnect	Alpha	optional, readonly	boolean | undefined	Disables the Container from reconnecting if false, allows reconnect otherwise.
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.
documentServiceFactory	Alpha	readonly	IDocumentServiceFactory	The document service factory take the Fluid url provided by the resolved url and constructs all the necessary services for communication with the container's server.
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
protocolHandlerBuilder	Alpha	optional, readonly	ProtocolHandlerBuilder | undefined	Optional property for allowing the container to use a custom protocol implementation for handling the quorum and/or the audience.
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 such that the container specified by the external url can be loaded.

Property Details

allowReconnect

Disables the Container from reconnecting if false, allows reconnect otherwise.

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 allowReconnect?: boolean | undefined;

Type: boolean | undefined

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

documentServiceFactory

The document service factory take the Fluid url provided by the resolved url and constructs all the necessary services for communication with the container's server.

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

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

protocolHandlerBuilder

Optional property for allowing the container to use a custom protocol implementation for handling the quorum and/or the audience.

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 protocolHandlerBuilder?: ProtocolHandlerBuilder | undefined;

Type: ProtocolHandlerBuilder | undefined

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 such that the container specified by the external url can be 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 urlResolver: IUrlResolver;

Type: IUrlResolver