@fluidframework/fluid-static Package

Provides a simple and powerful way to consume collaborative Fluid data.

Interfaces

Interface	Alerts	Modifiers	Description
ContainerSchema			Declares the Fluid objects that will be available in the Container.
IConnection			Base interface for information for each connection made to the Fluid session.
IFluidContainer		sealed	Provides an entrypoint into the client side of collaborative Fluid data. Provides access to the data as well as status on the collaboration session.
IFluidContainerEvents		sealed	Events emitted from IFluidContainer.
IMember			Base interface to be implemented to fetch each service's member.
IServiceAudience			Base interface to be implemented to fetch each service's audience.
IServiceAudienceEvents			Events that trigger when the roster of members in the Fluid session change.
TreeContainerSchema	Legacy		Declares the Fluid objects that will be available in the Container.

Types

TypeAlias	Description
CompatibilityMode	Determines the set of runtime options that Fluid Framework will use when running. In "1" mode we support full interop between 2.x clients and 1.x clients, while in "2" mode we only support interop between 2.x clients.
ContainerAttachProps	Represents properties that can be attached to a container.
InitialObjects	Extract the type of 'initialObjects' from the given ContainerSchema type.
MemberChangedListener	Signature for IMember change events.
Myself	An extended member object that includes currentConnection

Functions

Function	Alerts	Return Type	Description
createTreeContainerRuntimeFactory(props)	Legacy	IRuntimeFactory	Creates an @fluidframework/aqueduct#IRuntimeFactory which constructs containers with an entry point containing single tree-based root data object.

Function Details

createTreeContainerRuntimeFactory

Creates an @fluidframework/aqueduct#IRuntimeFactory which constructs containers with an entry point containing single tree-based root data object.

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

To use, import via @fluidframework/fluid-static/legacy.

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

Signature

export declare function createTreeContainerRuntimeFactory(props: {
    readonly schema: TreeContainerSchema;
    readonly compatibilityMode: CompatibilityMode;
    readonly rootDataStoreRegistry?: IFluidDataStoreRegistry;
    readonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;
    readonly minVersionForCollabOverride?: MinimumVersionForCollab;
}): IRuntimeFactory;

Remarks

The entry point is opaque to caller. The root data object's registry and shared objects are configured based on the provided SharedTree and optionally data store registry. \

Parameters

Parameter	Type	Description
props	{ readonly schema: TreeContainerSchema; readonly compatibilityMode: CompatibilityMode; readonly rootDataStoreRegistry?: IFluidDataStoreRegistry; readonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>; readonly minVersionForCollabOverride?: MinimumVersionForCollab; }

Returns

Return type: IRuntimeFactory