Class LockDetail

The information of a Lock.

Hierarchy

LockDetail

Index

Constructors

Properties

lockName? owner? ttl?

Constructors

constructor

new LockDetail(props?): LockDetail
Parameters
- Optional props: Partial<{
      lockName?: string;
      owner?: string;
      ttl?: number;
  }>
Returns LockDetail
- Defined in AgoraRtmBase.ts:948

Properties

`Optional` lockName

lockName?: string

The name of the lock.

`Optional` owner

owner?: string

The owner of the lock. Only valid when user getLocks or receive LockEvent with RTM_LOCK_EVENT_TYPE_SNAPSHOT

`Optional` ttl

ttl?: number = 0

The ttl of the lock.