RemoteChangeMetadata Interface
Information about a change that has been applied by a remote client.
To use, import via fluid-framework/alpha.
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 RemoteChangeMetadata extends CommitMetadata
Extends: CommitMetadata
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| getChange | Alpha | optional, readonly | undefined | Returns a serializable object that encodes the change. |
| getRevertible | Alpha | optional, readonly | undefined | Returns an object (a "revertible") that can be used to revert the change that produced this event. |
| isLocal | Alpha | readonly | false | Whether the change was made on the local machine/client or received from a remote client. |
| label | Alpha | optional, readonly | undefined | Label provided by the user when commit was created. |
| labels | Alpha | readonly | TransactionLabels | A set of labels from nested transaction labels. |
Property Details
getChange
Returns a serializable object that encodes the change.
For more information about our API support guarantees, see here.
Signature
readonly getChange?: undefined;
Type: undefined
Remarks
This is only available for local changes.
getRevertible
Returns an object (a "revertible") that can be used to revert the change that produced this event.
For more information about our API support guarantees, see here.
Signature
readonly getRevertible?: undefined;
Type: undefined
Remarks
This is only available for local changes.
isLocal
Whether the change was made on the local machine/client or received from a remote client.
For more information about our API support guarantees, see here.
Signature
readonly isLocal: false;
Type: false
label
Label provided by the user when commit was created.
For more information about our API support guarantees, see here.
Signature
readonly label?: undefined;
Type: undefined
Remarks
This is only available for local changes.
labels
A set of labels from nested transaction labels.
For more information about our API support guarantees, see here.
Signature
readonly labels: TransactionLabels;
Type: TransactionLabels
Remarks
This is always empty for remote changes. Labels are only available for local changes.