BriefcaseTxns Class
Manages local changes to a BriefcaseConnection via Txns.
@see - BriefcaseConnection.txns.
- TxnManager for the backend counterpart.
Extends
Implements
- TxnNotifications
Methods
Name | Description | |
---|---|---|
getRedoString(): Promise<string> | Get a description of the operation that would be reinstated by calling reinstateTxn. | |
getUndoString(): Promise<string> | Get the description of the operation that would be reversed by calling reverseTxns(1) . |
|
hasPendingTxns(): Promise<boolean> | Query if the briefcase has any pending Txns waiting to be pushed. | |
isRedoPossible(): Promise<boolean> | Determine if any reinstatable (redoable) changes exist. | |
isUndoPossible(): Promise<boolean> | Determine if any reversible (undoable) changes exist. | |
reinstateTxn(): Promise<IModelStatus> | Reinstate (redo) the most recently reversed transaction. | |
restartTxnSession(): Promise<void> | Restart the current TxnManager session. | |
reverseAll(): Promise<IModelStatus> | Reverse (undo) all changes back to the beginning of the session. | |
reverseSingleTxn(): Promise<IModelStatus> | Reverse (undo) the most recent operation. | |
reverseTxns(numOperations: number): Promise<IModelStatus> | Reverse (undo) the most recent operation(s) to the briefcase in the current session. |
Inherited methods
Name | Inherited from | Description |
---|---|---|
registerImpl(): RemoveFunction | BriefcaseNotificationHandler | |
register(): RemoveFunction Static | BriefcaseNotificationHandler | Register this class as the handler for notifications on its channel. |
Properties
Name | Type | Description | |
---|---|---|---|
onAfterUndoRedo Readonly | BeEvent<(isUndo: boolean) => void> | Event raised after an undo/redo operation is performed. | |
onBeforeUndoRedo Readonly | BeEvent<(isUndo: boolean) => void> | Event raised before an undo/redo operation is performed. | |
onChangesApplied Readonly | BeEvent<() => void> | Event raised after a changeset has been applied to the briefcase. | |
onChangesPulled Readonly | BeEvent<(parentChangeset: ChangesetIndexAndId) => void> | Event raised after changes are pulled and merged into the briefcase. | |
onChangesPushed Readonly | BeEvent<(parentChangeset: ChangesetIndexAndId) => void> | Event raised after the briefcase's local changes are pushed. | |
onCommit Readonly | BeEvent<() => void> | Event raised before a commit operation is performed. | |
onCommitted Readonly | BeEvent<(hasPendingTxns: boolean, time: number) => void> | Event raised after a commit operation is performed. | |
onElementsChanged Readonly | BeEvent<(changes: TxnEntityChanges) => void> | Event raised after Txn validation or changeset application to indicate the set of changed elements. | |
onModelGeometryChanged Readonly | BeEvent<(changes: ReadonlyArray<ModelIdAndGeometryGuid>) => void> | Event raised after the geometry within one or more GeometricModelStates is modified by applying a changeset or validation of a transaction. | |
onModelsChanged Readonly | BeEvent<(changes: TxnEntityChanges) => void> | Event raised after Txn validation or changeset application to indicate the set of changed models. | |
onReplayedExternalTxns Readonly | BeEvent<() => void> | Event raised for a read-only briefcase that was opened with the watchForChanges flag enabled when changes made by another connection are applied to the briefcase. |
|
onReplayExternalTxns Readonly | BeEvent<() => void> | Event raised for a read-only briefcase that was opened with the watchForChanges flag enabled when changes made by another connection are applied to the briefcase. |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
channelName Accessor ReadOnly | string | BriefcaseNotificationHandler | All subclasses must implement this method to specify their response channel name. |
Defined in
Last Updated: 28 October, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.