LockControl Interface

Interface for acquiring element locks to coordinate simultaneous edits from multiple briefcases.

Methods

Name Description
acquireLocks(arg: { exclusive?: Id64Arg, shared?: Id64Arg }): Promise<void> Acquire locks on one or more elements from the lock server, if required and not already held.  
holdsExclusiveLock(id: string): boolean Determine whether the supplied element currently holds the exclusive lock  
holdsSharedLock(id: string): boolean Determine whether the supplied element currently holds a shared lock  
releaseAllLocks(): Promise<void> Release all locks currently held by this Briefcase from the lock server.  

Properties

Name Type Description
isServerBased Readonly boolean true if this LockControl uses a server-based concurrency approach.  

Defined in

Last Updated: 15 March, 2024