StageControlsExperimental 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.

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 StageControlsExperimental

Properties

Property	Alerts	Modifiers	Type	Description
commitChanges	Alpha	readonly	(options?: Partial<CommitStagedChangesOptionsExperimental>) => 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.

This API is provided for existing users, but is not recommended for new users.

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

readonly commitChanges: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void;

Type: (options?: Partial<CommitStagedChangesOptionsExperimental>) => void

discardChanges

Exit staging mode and discard any changes made while in staging mode.

This API is provided for existing users, but is not recommended for new users.

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

readonly discardChanges: () => void;

Type: () => void