IContainerRuntime Interface
Packages > @fluidframework/container-runtime-definitions > IContainerRuntime
Represents the runtime of the container. Contains helper functions/state of the container.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-runtime-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
/** @sealed */
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents
Extends: IProvideFluidDataStoreRegistry , IContainerRuntimeBaseWithCombinedEvents
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| attachState | Alpha |
readonly |
AttachState | Indicates the attachment state of the container to a host service. |
| clientDetails | Alpha |
readonly |
IClientDetails | |
| clientId | Alpha |
readonly |
string | undefined | |
| connected | Alpha |
readonly |
boolean | |
| deltaManager | Alpha |
readonly |
IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> | |
| flushMode | Alpha |
readonly |
FlushMode | |
| isDirty | Alpha |
readonly |
boolean | Returns true if document is dirty, i.e. there are some pending local changes that either were not sent out to delta stream or were not yet acknowledged. |
| options | Alpha |
readonly |
Record<string | number, any> | |
| scope | Alpha |
readonly |
FluidObject | |
| storage | Alpha |
readonly |
IDocumentStorageService |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getAbsoluteUrl(relativeUrl) | Alpha |
Promise<string | undefined> | Get an absolute url for a provided container-relative request. Returns undefined if the container isn't attached to storage. |
Property Details
attachState
Indicates the attachment state of the container to a host service.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly attachState: AttachState;
Type: AttachState
clientDetails
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly clientDetails: IClientDetails;
Type: IClientDetails
clientId
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly clientId: string | undefined;
Type: string | undefined
connected
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly connected: boolean;
Type: boolean
deltaManager
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
Type: IDeltaManager <ISequencedDocumentMessage , IDocumentMessage >
flushMode
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly flushMode: FlushMode;
Type: FlushMode
isDirty
Returns true if document is dirty, i.e. there are some pending local changes that either were not sent out to delta stream or were not yet acknowledged.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly isDirty: boolean;
Type: boolean
options
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly options: Record<string | number, any>;
Type: Record<string | number, any>
scope
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly scope: FluidObject;
Type: FluidObject
storage
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly storage: IDocumentStorageService;
Type: IDocumentStorageService
Method Details
getAbsoluteUrl
Get an absolute url for a provided container-relative request. Returns undefined if the container isn’t attached to storage.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| relativeUrl | string | A relative request within the container |
Returns
Return type: Promise<string | undefined>