Class LockEvent

Hierarchy

LockEvent

Index

Constructors

constructor

Properties

channelName? channelType? count? eventType? lockDetailList? timestamp?

Constructors

constructor

new LockEvent(props?): LockEvent
Parameters
- Optional props: Partial<{
      channelName?: string;
      channelType?: RtmChannelType;
      count?: number;
      eventType?: RtmLockEventType;
      lockDetailList?: LockDetail[];
      timestamp?: number;
  }>
Returns LockEvent
- Defined in legacy/IAgoraRtmClient.ts:427

Properties

`Optional` channelName

channelName?: string

The channel which the lock event was triggered

`Optional` channelType

channelType?: RtmChannelType

Which channel type, RtmChannelType_STREAM or message

`Optional` count

count?: number

The count of locks

`Optional` eventType

eventType?: RtmLockEventType

Lock event type, indicate lock states

`Optional` lockDetailList

lockDetailList?: LockDetail[]

The detail information of locks

`Optional` timestamp

timestamp?: number

RTM server UTC time

Class LockEvent

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

`Optional` props: Partial<{
    channelName?: string;
    channelType?: RtmChannelType;
    count?: number;
    eventType?: RtmLockEventType;
    lockDetailList?: LockDetail[];
    timestamp?: number;
}>

Returns LockEvent

Properties

`Optional` channelName

`Optional` channelType

`Optional` count

`Optional` eventType

`Optional` lockDetailList

`Optional` timestamp

Settings

Member Visibility

Theme

On This Page

Class LockEvent

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Optional props: Partial<{ channelName?: string; channelType?: RtmChannelType; count?: number; eventType?: RtmLockEventType; lockDetailList?: LockDetail[]; timestamp?: number; }>

Returns LockEvent

Properties

Optional channelName

Optional channelType

Optional count

Optional eventType

Optional lockDetailList

Optional timestamp

Settings

Member Visibility

Theme

On This Page

`Optional` props: Partial<{
channelName?: string;
channelType?: RtmChannelType;
count?: number;
eventType?: RtmLockEventType;
lockDetailList?: LockDetail[];
timestamp?: number;
}>

`Optional` channelName

`Optional` channelType

`Optional` count

`Optional` eventType

`Optional` lockDetailList

`Optional` timestamp