FluidContainerAttached Interface
A Fluid container that has been attached to a service.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Sealed
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface FluidContainerAttached<TData = unknown> extends FluidContainer<TData>
Extends: FluidContainer<TData>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TData | unknown | The type of the container's root data store. |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| id | Alpha | readonly | string | The unique identifier for this container within its service. |
Property Details
id
The unique identifier for this container within its service.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly id: string;
Type: string
Remarks
undefined if the container has not yet been attached to a service. This can be used to load another instance of this container from the service using loadContainer(id, root).