Package io.agora.rtm

Class GetOnlineUsersOptions

java.lang.Object

io.agora.rtm.GetOnlineUsersOptions

public class GetOnlineUsersOptions
extends Object

This class represents options for retrieving online users. It provides the ability to specify whether to include the user ID, user state, and pagination data when retrieving online users.

Constructor Summary

Constructors

Constructor	Description
GetOnlineUsersOptions()	Constructs an GetOnlineUsersOptions object with default parameters.
GetOnlineUsersOptions(boolean includeUserId, boolean includeState)	Constructs an GetOnlineUsersOptions object with the specified options(whether include user id and state)
GetOnlineUsersOptions(boolean includeUserId, boolean includeState, String page)	Constructs a new instance of GetOnlineUsersOptions 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

GetOnlineUsersOptions

public GetOnlineUsersOptions()

Constructs an GetOnlineUsersOptions object with default parameters.

GetOnlineUsersOptions

public GetOnlineUsersOptions(boolean includeUserId,
 boolean includeState)

Constructs an GetOnlineUsersOptions object with the specified options(whether include user id and state)

Parameters:

includeUserId - Whether to display user id in query result

includeState - Whether to display user state in query result

GetOnlineUsersOptions

public GetOnlineUsersOptions(boolean includeUserId,
 boolean includeState,
 String page)

Constructs a new instance of GetOnlineUsersOptions 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