Class RTMLock`Abstract`

Hierarchy

RTMLock

Index

Constructors

Methods

acquireLock getLock releaseLock removeLock revokeLock setLock

Constructors

constructor

new RTMLock(): RTMLock
Returns RTMLock

Methods

`Abstract` acquireLock

acquireLock(channelName, channelType, lockName, options?): Promise<LockOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- lockName: string
- Optional options: AcquireLockOptions
Returns Promise<LockOperationResponse>
- Defined in api/RTMLock.ts:49

`Abstract` getLock

getLock(channelName, channelType): Promise<GetLockResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
Returns Promise<GetLockResponse>
- Defined in api/RTMLock.ts:69

`Abstract` releaseLock

releaseLock(channelName, channelType, lockName): Promise<LockOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- lockName: string
Returns Promise<LockOperationResponse>
- Defined in api/RTMLock.ts:56

`Abstract` removeLock

removeLock(channelName, channelType, lockName): Promise<LockOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- lockName: string
Returns Promise<LockOperationResponse>
- Defined in api/RTMLock.ts:43

`Abstract` revokeLock

revokeLock(channelName, channelType, lockName, owner): Promise<LockOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- lockName: string
- owner: string
Returns Promise<LockOperationResponse>
- Defined in api/RTMLock.ts:62

`Abstract` setLock

setLock(channelName, channelType, lockName, options?): Promise<LockOperationResponse>
Parameters
- channelName: string
- channelType: RtmChannelType
- lockName: string
- Optional options: SetLockOptions
Returns Promise<LockOperationResponse>
- Defined in api/RTMLock.ts:36