abandonLocks @beta

abandonLocks: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void> | undefined

Abandons the specified locks when none of the associated elements have been or will be modified. Depending on the LockState specified for the lock, it may be returned to the LockState.Shared state or released entirely. It is only valid to call this method when none of the elements protected by the locks have been edited, or if all edits have been reversed or abandoned without pushing them.

The locks are released on the IModelHub, but the changeset associated with the locks is not updated.

It is an error to specify Exclusive for any element, to specify LockState.Shared for an element where the Exclusive lock is not currently held, or to include any element for which no lock is currently held.

This method is optional, so not all IModelHubs will implement it. If this method is not implemented explicitly by an IModelHub, it will be implemented implicitly by calling acquireLocks with the same locks and passing changeset.id="" and changeset.index=0 in the first argument to indicate that the lock state should change without updating the changeset associated with the locks.

Defined in

• backend/src/BackendHubAccess.ts Line 248