\hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options}{}\doxysection{io.\+agora.\+rtm.\+Get\+Online\+Users\+Options Class Reference}
\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options}\index{io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}{Get\+Online\+Users\+Options}} ()
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_aadec70863558bb6bf101e2cf21ecd64e}{Get\+Online\+Users\+Options}} (boolean include\+User\+Id, boolean include\+State)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_abc64ab8c816f032b1453c6aea1ea83ac}{Get\+Online\+Users\+Options}} (boolean include\+User\+Id, boolean include\+State, String page)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a2e4851a7e4c2f13fce08fd3f55a8699c}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a2e4851a7e4c2f13fce08fd3f55a8699c}} 
void {\bfseries set\+Include\+User\+Id} (boolean include\+User\+Id)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_ac59aeedca8b9a5dea3825628a92dbe93}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_ac59aeedca8b9a5dea3825628a92dbe93}} 
void {\bfseries set\+Include\+State} (boolean include\+State)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_ab24be3c7d864317ceed63ecab827e915}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_ab24be3c7d864317ceed63ecab827e915}} 
void {\bfseries set\+Page} (String page)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a2159c79157b5a579f819acce7f470f72}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a2159c79157b5a579f819acce7f470f72}} 
boolean {\bfseries get\+Include\+User\+Id} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a741549070c0ed7754b44b1a42c94cb24}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a741549070c0ed7754b44b1a42c94cb24}} 
boolean {\bfseries get\+Include\+State} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a583b70d1ca9fe23ee53ee9a4241ea208}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a583b70d1ca9fe23ee53ee9a4241ea208}} 
String {\bfseries get\+Page} ()
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a30271847435a4625a52b61dc43f766b8}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a30271847435a4625a52b61dc43f766b8}} 
String {\bfseries to\+String} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
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. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}} 
\index{io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}!GetOnlineUsersOptions@{GetOnlineUsersOptions}}
\index{GetOnlineUsersOptions@{GetOnlineUsersOptions}!io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}}
\doxysubsubsection{\texorpdfstring{GetOnlineUsersOptions()}{GetOnlineUsersOptions()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily io.\+agora.\+rtm.\+Get\+Online\+Users\+Options.\+Get\+Online\+Users\+Options (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

Constructs an
\begin{DoxyCode}{0}
\DoxyCodeLine{\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}{GetOnlineUsersOptions}} }
\end{DoxyCode}
 object with default parameters. \mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_aadec70863558bb6bf101e2cf21ecd64e}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_aadec70863558bb6bf101e2cf21ecd64e}} 
\index{io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}!GetOnlineUsersOptions@{GetOnlineUsersOptions}}
\index{GetOnlineUsersOptions@{GetOnlineUsersOptions}!io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}}
\doxysubsubsection{\texorpdfstring{GetOnlineUsersOptions()}{GetOnlineUsersOptions()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily io.\+agora.\+rtm.\+Get\+Online\+Users\+Options.\+Get\+Online\+Users\+Options (\begin{DoxyParamCaption}\item[{boolean}]{include\+User\+Id,  }\item[{boolean}]{include\+State }\end{DoxyParamCaption})}

Constructs an
\begin{DoxyCode}{0}
\DoxyCodeLine{\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}{GetOnlineUsersOptions}} }
\end{DoxyCode}
 object with the specified options(whether include user id and state)


\begin{DoxyParams}{Parameters}
{\em include\+User\+Id} & Whether to display user id in query result \\
\hline
{\em include\+State} & Whether to display user state in query result \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{classio_1_1agora_1_1rtm_1_1_get_online_users_options_abc64ab8c816f032b1453c6aea1ea83ac}\label{classio_1_1agora_1_1rtm_1_1_get_online_users_options_abc64ab8c816f032b1453c6aea1ea83ac}} 
\index{io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}!GetOnlineUsersOptions@{GetOnlineUsersOptions}}
\index{GetOnlineUsersOptions@{GetOnlineUsersOptions}!io.agora.rtm.GetOnlineUsersOptions@{io.agora.rtm.GetOnlineUsersOptions}}
\doxysubsubsection{\texorpdfstring{GetOnlineUsersOptions()}{GetOnlineUsersOptions()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily io.\+agora.\+rtm.\+Get\+Online\+Users\+Options.\+Get\+Online\+Users\+Options (\begin{DoxyParamCaption}\item[{boolean}]{include\+User\+Id,  }\item[{boolean}]{include\+State,  }\item[{String}]{page }\end{DoxyParamCaption})}

Constructs a new instance of
\begin{DoxyCode}{0}
\DoxyCodeLine{\mbox{\hyperlink{classio_1_1agora_1_1rtm_1_1_get_online_users_options_a9605aab81b72c564483b5a86a1c43107}{GetOnlineUsersOptions}} }
\end{DoxyCode}
 with the specified options.


\begin{DoxyParams}{Parameters}
{\em include\+User\+Id} & specifies whether to include the user ID in the query result. \\
\hline
{\em include\+State} & specifies whether to include the user state in the query result. \\
\hline
{\em page} & the string of page for pagination \\
\hline
\end{DoxyParams}
