Package io.agora.rtm

Class RtmPresence

java.lang.Object

io.agora.rtm.RtmPresence

public abstract class RtmPresence
extends Object

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

Constructor Summary

Constructors

Constructor	Description
RtmPresence()

Method Summary

Modifier and Type	Method	Description
abstract void	getOnlineUsers(String channelName, RtmConstants.RtmChannelType channelType, GetOnlineUsersOptions options, ResultCallback<GetOnlineUsersResult> resultCallback)	To query who joined this channel
abstract void	getState(String channelName, RtmConstants.RtmChannelType channelType, String userId, ResultCallback<UserState> resultCallback)	Get user state
abstract void	getUserChannels(String userId, ResultCallback<ArrayList<ChannelInfo>> resultCallback)	To query which channels the user joined or subscribed
abstract void	removeState(String channelName, RtmConstants.RtmChannelType channelType, ArrayList<String> keys, ResultCallback<Void> resultCallback)	Delete user state
abstract void	setState(String channelName, RtmConstants.RtmChannelType channelType, Map<String,String> items, ResultCallback<Void> resultCallback)	Set user state
abstract void	whereNow(String userId, ResultCallback<ArrayList<ChannelInfo>> resultCallback)	To query which channels the user joined
abstract void	whoNow(String channelName, RtmConstants.RtmChannelType channelType, PresenceOptions options, ResultCallback<WhoNowResult> resultCallback)	To query who joined this channel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RtmPresence

public RtmPresence()

Method Details

whoNow

public abstract void whoNow(String channelName,
 RtmConstants.RtmChannelType channelType,
 PresenceOptions options,
 ResultCallback<WhoNowResult> resultCallback)

To query who joined this channel

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

options - The query option.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

whereNow

public abstract void whereNow(String userId,
 ResultCallback<ArrayList<ChannelInfo>> resultCallback)

To query which channels the user joined

Parameters:

userId - The id of the user.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getOnlineUsers

public abstract void getOnlineUsers(String channelName,
 RtmConstants.RtmChannelType channelType,
 GetOnlineUsersOptions options,
 ResultCallback<GetOnlineUsersResult> resultCallback)

To query who joined this channel

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

options - The query option.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getUserChannels

public abstract void getUserChannels(String userId,
 ResultCallback<ArrayList<ChannelInfo>> resultCallback)

To query which channels the user joined or subscribed

Parameters:

userId - The id of the user.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

setState

public abstract void setState(String channelName,
 RtmConstants.RtmChannelType channelType,
 Map<String,String> items,
 ResultCallback<Void> resultCallback)

Set user state

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

items - The states item of user.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

removeState

public abstract void removeState(String channelName,
 RtmConstants.RtmChannelType channelType,
 ArrayList<String> keys,
 ResultCallback<Void> resultCallback)

Delete user state

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

keys - The keys of state item.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.

getState

public abstract void getState(String channelName,
 RtmConstants.RtmChannelType channelType,
 String userId,
 ResultCallback<UserState> resultCallback)

Get user state

Parameters:

channelName - The name of the channel.

channelType - The type of the channel.

userId - The id of the user.

resultCallback - A ResultCallback object. - Success: will receives the ResultCallback.onSuccess(Object) callback. - Failure: will receives the ResultCallback.onFailure(ErrorInfo) callback.