Agora Java API Reference for Android

Public Member Functions | List of all members
io.agora.rtm.PresenceOptions Class Reference

## Public Member Functions
| PresenceOptions ()
| PresenceOptions (boolean includeUserId, boolean includeState)
| PresenceOptions (boolean includeUserId, boolean includeState, String page)
void | setIncludeUserId (boolean includeUserId)
void | setIncludeState (boolean includeState)
void | setPage (String page)
boolean | getIncludeUserId ()
boolean | getIncludeState ()
String | getPage ()
String | toString ()

## Detailed Description

The option to query user presence.

## Constructor & Destructor Documentation

## ◆ PresenceOptions() [1/3]

io.agora.rtm.PresenceOptions.PresenceOptions | ( |  | ) |

Creates a new instance of

PresenceOptions

with default parameters.

## ◆ PresenceOptions() [2/3]

io.agora.rtm.PresenceOptions.PresenceOptions | ( | boolean | includeUserId,
|  | boolean | includeState
| ) |  |

Creates a new instance of

PresenceOptions

with specifies options.

Parameters

  includeUserId | Whether to display user id in query result
  includeState | Whether to display user state in query result

## ◆ PresenceOptions() [3/3]

io.agora.rtm.PresenceOptions.PresenceOptions | ( | boolean | includeUserId,
|  | boolean | includeState,
|  | String | page
| ) |  |

Creates a new instance of

PresenceOptions

with the specified options.

Parameters

  includeUserId | specifies whether to include the user ID in the query result.
  includeState | specifies whether to include the user state in the query result.
  page | the string of page for pagination

io.agora.rtm.PresenceOptions.PresenceOptions
PresenceOptions()
Definition: PresenceOptions.java:27