IContainerRuntimeBaseExperimental Interface
This API is deprecated and will be removed in a future release.
-
These APIs are unstable, and can be changed at will. They should only be used with direct agreement with the Fluid Framework.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
/** @sealed */
export interface IContainerRuntimeBaseExperimental extends IContainerRuntimeBase
Extends: IContainerRuntimeBase
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| inStagingMode | Alpha |
optional, readonly |
boolean |
Methods
| Method | Alerts | Modifiers | Return Type | Description |
|---|---|---|---|---|
| enterStagingMode() | Alpha |
optional |
StageControlsExperimental |
Property Details
inStagingMode
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 inStagingMode?: boolean;
Type: boolean
Method Details
enterStagingMode
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
enterStagingMode?(): StageControlsExperimental;
Returns
Return type: StageControlsExperimental