PresenceOptions

java.lang.Object

io.agora.rtm.PresenceOptions

public class PresenceOptions extends Object

The option to query user presence.

Constructor Summary

Constructors

Constructor

Description

PresenceOptions()

Creates a new instance of PresenceOptions with default parameters.

PresenceOptions(boolean includeUserId, boolean includeState)

Creates a new instance of PresenceOptions with specifies options.

PresenceOptions(boolean includeUserId, boolean includeState, String page)

Creates a new instance of PresenceOptions with the specified options.
Method Summary

Modifier and Type

Method

Description

boolean

getIncludeState()

boolean

getIncludeUserId()

String

getPage()

void

setIncludeState(boolean includeState)

void

setIncludeUserId(boolean includeUserId)

void

setPage(String page)

String

toString()

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- PresenceOptions
  
  public PresenceOptions()
  
  Creates a new instance of PresenceOptions with default parameters.
- PresenceOptions
  
  public 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
  
  public 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
Method Details
- setIncludeUserId
  
  public void setIncludeUserId(boolean includeUserId)
- setIncludeState
  
  public void setIncludeState(boolean includeState)
- setPage
  
  public void setPage(String page)
- getIncludeUserId
  
  public boolean getIncludeUserId()
- getIncludeState
  
  public boolean getIncludeState()
- getPage
  
  public String getPage()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object