Class GetOnlineUsersOptions

The option to query user presence.

Hierarchy

GetOnlineUsersOptions

Index

Constructors

Properties

includeState? includeUserId? page?

Constructors

constructor

new GetOnlineUsersOptions(props?): GetOnlineUsersOptions
Parameters
- Optional props: Partial<{
      includeState?: boolean;
      includeUserId?: boolean;
      page?: string;
  }>
Returns GetOnlineUsersOptions
- Defined in AgoraRtmBase.ts:1083

Properties

`Optional` includeState

includeState?: boolean = false

Whether to display user state in query result

`Optional` includeUserId

includeUserId?: boolean = true

Whether to display user id in query result

`Optional` page

page?: string

The paging object used for pagination.