StageControlsAlpha Interface
Controls for managing staged changes in alpha staging mode.
Provides methods to either commit or discard changes made while in staging mode.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here.
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 StageControlsAlpha
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| commitChanges | Alpha |
readonly |
() => void | Exit staging mode and commit to any changes made while in staging mode. This will cause them to be sent to the ordering service, and subsequent changes made by this container will additionally flow freely to the ordering service. |
| discardChanges | Alpha |
readonly |
() => void | Exit staging mode and discard any changes made while in staging mode. |
Property Details
commitChanges
Exit staging mode and commit to any changes made while in staging mode. This will cause them to be sent to the ordering service, and subsequent changes made by this container will additionally flow freely to the ordering service.
For more information about our API support guarantees, see here.
Signature
readonly commitChanges: () => void;
Type: () => void
discardChanges
Exit staging mode and discard any changes made while in staging mode.
For more information about our API support guarantees, see here.
Signature
readonly discardChanges: () => void;
Type: () => void