Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.rtm.RtmPresence Class Referenceabstract

Public Member Functions

abstract void whoNow (String channelName, RtmChannelType channelType, PresenceOptions options, ResultCallback< WhoNowResult > resultCallback)
 
abstract void whereNow (String userId, ResultCallback< ArrayList< ChannelInfo >> resultCallback)
 
abstract void getOnlineUsers (String channelName, RtmChannelType channelType, GetOnlineUsersOptions options, ResultCallback< GetOnlineUsersResult > resultCallback)
 
abstract void getUserChannels (String userId, ResultCallback< ArrayList< ChannelInfo >> resultCallback)
 
abstract void setState (String channelName, RtmChannelType channelType, Map< String, String > items, ResultCallback< Void > resultCallback)
 
abstract void removeState (String channelName, RtmChannelType channelType, ArrayList< String > keys, ResultCallback< Void > resultCallback)
 
abstract void getState (String channelName, RtmChannelType channelType, String userId, ResultCallback< UserState > resultCallback)
 

Detailed Description

The RtmPresence class.

This class provides the rtm presence methods that can be invoked by your app.

Member Function Documentation

◆ whoNow()

abstract void io.agora.rtm.RtmPresence.whoNow ( String  channelName,
RtmChannelType  channelType,
PresenceOptions  options,
ResultCallback< WhoNowResult resultCallback 
)
abstract

To query who joined this channel

Parameters
channelNameThe name of the channel.
channelTypeThe type of the channel.
optionsThe query option.
resultCallbackA ResultCallback object.

◆ whereNow()

abstract void io.agora.rtm.RtmPresence.whereNow ( String  userId,
ResultCallback< ArrayList< ChannelInfo >>  resultCallback 
)
abstract

To query which channels the user joined

Parameters
userIdThe id of the user.
resultCallbackA ResultCallback object.

◆ getOnlineUsers()

abstract void io.agora.rtm.RtmPresence.getOnlineUsers ( String  channelName,
RtmChannelType  channelType,
GetOnlineUsersOptions  options,
ResultCallback< GetOnlineUsersResult resultCallback 
)
abstract

To query who joined this channel

Parameters
channelNameThe name of the channel.
channelTypeThe type of the channel.
optionsThe query option.
resultCallbackA ResultCallback object.

◆ getUserChannels()

abstract void io.agora.rtm.RtmPresence.getUserChannels ( String  userId,
ResultCallback< ArrayList< ChannelInfo >>  resultCallback 
)
abstract

To query which channels the user joined or subscribed

Parameters
userIdThe id of the user.
resultCallbackA ResultCallback object.

◆ setState()

abstract void io.agora.rtm.RtmPresence.setState ( String  channelName,
RtmChannelType  channelType,
Map< String, String >  items,
ResultCallback< Void >  resultCallback 
)
abstract

Set user state

Parameters
channelNameThe name of the channel.
channelTypeThe type of the channel.
itemsThe states item of user.
resultCallbackA ResultCallback object.

◆ removeState()

abstract void io.agora.rtm.RtmPresence.removeState ( String  channelName,
RtmChannelType  channelType,
ArrayList< String >  keys,
ResultCallback< Void >  resultCallback 
)
abstract

Delete user state

Parameters
channelNameThe name of the channel.
channelTypeThe type of the channel.
keysThe keys of state item.
resultCallbackA ResultCallback object.

◆ getState()

abstract void io.agora.rtm.RtmPresence.getState ( String  channelName,
RtmChannelType  channelType,
String  userId,
ResultCallback< UserState resultCallback 
)
abstract

Get user state

Parameters
channelNameThe name of the channel.
channelTypeThe type of the channel.
userIdThe id of the user.
resultCallbackA ResultCallback object.