Class PresenceEvent

Hierarchy

PresenceEvent

Index

Constructors

constructor

Properties

channelName? channelType? interval? publisher? snapshot? stateItemCount? stateItems? type?

Constructors

constructor

new PresenceEvent(props?): PresenceEvent
Parameters
- Optional props: Partial<{
      channelName?: string;
      channelType?: RTM_CHANNEL_TYPE;
      interval?: IntervalInfo;
      publisher?: string;
      snapshot?: SnapshotInfo;
      stateItemCount?: number;
      stateItems?: StateItem[];
      type?: RTM_PRESENCE_EVENT_TYPE;
  }>
Returns PresenceEvent
- Defined in IAgoraRtmClient.ts:273

Properties

`Optional` channelName

channelName?: string

The channel which the presence event was triggered

`Optional` channelType

channelType?: RTM_CHANNEL_TYPE

Which channel type, RTM_CHANNEL_TYPE_STREAM or RTM_CHANNEL_TYPE_MESSAGE

`Optional` interval

interval?: IntervalInfo

Only valid when in interval mode

`Optional` publisher

publisher?: string

The user who triggered this event.

`Optional` snapshot

snapshot?: SnapshotInfo

Only valid when receive snapshot event

`Optional` stateItemCount

stateItemCount?: number

The states count

`Optional` stateItems

stateItems?: StateItem[]

The user states

`Optional` type

type?: RTM_PRESENCE_EVENT_TYPE

Indicate presence event type

Class PresenceEvent

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

`Optional` props: Partial<{
    channelName?: string;
    channelType?: RTM_CHANNEL_TYPE;
    interval?: IntervalInfo;
    publisher?: string;
    snapshot?: SnapshotInfo;
    stateItemCount?: number;
    stateItems?: StateItem[];
    type?: RTM_PRESENCE_EVENT_TYPE;
}>

Returns PresenceEvent

Properties

`Optional` channelName

`Optional` channelType

`Optional` interval

`Optional` publisher

`Optional` snapshot

`Optional` stateItemCount

`Optional` stateItems

`Optional` type

Settings

Member Visibility

Theme

On This Page

Class PresenceEvent

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

Optional props: Partial<{ channelName?: string; channelType?: RTM_CHANNEL_TYPE; interval?: IntervalInfo; publisher?: string; snapshot?: SnapshotInfo; stateItemCount?: number; stateItems?: StateItem[]; type?: RTM_PRESENCE_EVENT_TYPE; }>

Returns PresenceEvent

Properties

Optional channelName

Optional channelType

Optional interval

Optional publisher

Optional snapshot

Optional stateItemCount

Optional stateItems

Optional type

Settings

Member Visibility

Theme

On This Page

`Optional` props: Partial<{
channelName?: string;
channelType?: RTM_CHANNEL_TYPE;
interval?: IntervalInfo;
publisher?: string;
snapshot?: SnapshotInfo;
stateItemCount?: number;
stateItems?: StateItem[];
type?: RTM_PRESENCE_EVENT_TYPE;
}>

`Optional` channelName

`Optional` channelType

`Optional` interval

`Optional` publisher

`Optional` snapshot

`Optional` stateItemCount

`Optional` stateItems

`Optional` type