Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionLock

Hierarchy

  • SessionLock

Index

Methods

getName

  • getName(): string
  • Returns string

    the name of the session lock

getScope

  • Returns SessionLockScope

    the lock scope

getSequence

  • getSequence(): Long
  • Returns Long

    a value that identifies the acquisition of this lock

isOwned

  • isOwned(): boolean
  • Returns boolean

    true if the session lock is still owned by the session

unlock

  • Returns Result<boolean>

    a Promise that resolves when a response is received from the server.

    On completion, this session will no longer own the named session lock. If Promise completes normally, a true value indicates this session previously owned the lock and a false value indicates it did not.

    If the Promise resolves with an error, this session does not own the session lock.