@fluidframework/fluid-static Package
Provides a simple and powerful way to consume collaborative Fluid data.
Interfaces
| Interface | Description |
|---|---|
| ContainerSchema | The ContainerSchema declares the Fluid objects that will be available in the container. It includes both the instances of objects that are initially available upon container creation, as well as the types of objects that may be dynamically created throughout the lifetime of the container. |
| IConnection | Base interface for information for each connection made to the Fluid session. This interface can be extended to provide additional information specific to each service. |
| IFluidContainer | 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 | Events emitted from IFluidContainer. |
| IMember | Base interface to be implemented to fetch each service's member. This interface can be extended by each service to provide additional service-specific user metadata. |
| IServiceAudience | Base interface to be implemented to fetch each service's audience. The generic M allows consumers to further extend the client object with service-specific details about the connecting client, such as device information, environment, or a username. |
| IServiceAudienceEvents | Events that trigger when the roster of members in the Fluid session change. Only changes that would be reflected in the returned map of IServiceAudience's getMembers() method will emit events. |
| RootDataObjectProps | Input props for initializingFirstTime(props) |
Classes
| Class | Description |
|---|---|
| DOProviderContainerRuntimeFactory | Container code that provides a single RootDataObject. This data object is dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory. |
| FluidContainer | Base IFluidContainer implementation. |
| RootDataObject | The entry-point/root collaborative object of the Fluid Container. This class abstracts the dynamic code required to build a Fluid Container into a static representation for end customers. |
| ServiceAudience | Base class for providing audience information for sessions interacting with FluidContainer This can be extended by different service-specific client packages to additional parameters to the user and client details returned in IMember |
Types
| TypeAlias | Description |
|---|---|
| DataObjectClass | A DataObjectClass is a class that has a factory that can create a DataObject and a constructor that will return the type of the DataObject. |
| LoadableObjectClass | A LoadableObjectClass is an class object of DataObject or SharedObject |
| LoadableObjectClassRecord | A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject or SharedObject in a LoadableObjectRecord. |
| LoadableObjectCtor | An object with a constructor that will return an IFluidLoadable. |
| LoadableObjectRecord | A mapping of string identifiers to instantiated DataObjects or SharedObjects. |
| SharedObjectClass | A SharedObjectClass is a class that has a factory that can create a DDS (SharedObject) and a constructor that will return the type of the DataObject. |