即时通讯 IM API 参考 v1.3.2
Agora Java IM SDK
Public 成员函数 | 所有成员列表
io.agora.chat.PresenceManager类 参考

Public 成员函数

void publishPresence (String customStatus, CallBack callBack)
 
void subscribePresences (List< String > members, long expiry, ValueCallBack< List< Presence > > callBack)
 
void unsubscribePresences (List< String > members, CallBack callBack)
 
void fetchSubscribedMembers (int pageNum, int pageSize, ValueCallBack< List< String > > callBack)
 
void fetchPresenceStatus (List< String > members, ValueCallBack< List< Presence > > callBack)
 
void addListener (PresenceListener listener)
 
void removeListener (PresenceListener listener)
 
void clearListeners ()
 

详细描述

在线状态管理类,提供在线状态管理功能。

成员函数说明

◆ addListener()

void io.agora.chat.PresenceManager.addListener ( PresenceListener  listener)

添加监听。

参数
listenerPresenceListener 要添加的监听。

◆ clearListeners()

void io.agora.chat.PresenceManager.clearListeners ( )

清空所有监听者

◆ fetchPresenceStatus()

void io.agora.chat.PresenceManager.fetchPresenceStatus ( List< String >  members,
ValueCallBack< List< Presence > >  callBack 
)

查询指定用户的当前在线状态。

参数
members用户 ID 数组,指定要查询哪些用户的在线状态。
callBack完成回调,返回用户的在线状态。

◆ fetchSubscribedMembers()

void io.agora.chat.PresenceManager.fetchSubscribedMembers ( int  pageNum,
int  pageSize,
ValueCallBack< List< String > >  callBack 
)

分页查询当前用户订阅了哪些用户的在线状态。

参数
pageNum当前页码,从 1 开始。
pageSize每页的订阅用户的数量。
callBack完成回调,返回订阅的在线状态所属的用户 ID。若当前未订阅任何用户的在线状态,返回空值。

◆ publishPresence()

void io.agora.chat.PresenceManager.publishPresence ( String  customStatus,
CallBack  callBack 
)

发布自定义在线状态。

参数
customStatus自定义在线状态。可通过 Presence#getExt()来获取自定义状态。
callBack该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ removeListener()

void io.agora.chat.PresenceManager.removeListener ( PresenceListener  listener)

移除监听。

参数
listenerPresenceListener 要移除的监听。

◆ subscribePresences()

void io.agora.chat.PresenceManager.subscribePresences ( List< String >  members,
long  expiry,
ValueCallBack< List< Presence > >  callBack 
)

订阅指定用户的在线状态。订阅成功后,在线状态变更时订阅者会收到回调通知。

参数
members要订阅在线状态的用户 ID 数组。
expiry订阅到期时间。单位秒,最长30天。
callBack该方法完成调用的回调。如果该方法调用成功,会返回订阅用户的当前状态,调用失败,会包含调用失败的原因。

◆ unsubscribePresences()

void io.agora.chat.PresenceManager.unsubscribePresences ( List< String >  members,
CallBack  callBack 
)

取消订阅指定用户的在线状态。

参数
members要取消订阅在线状态的用户 ID 数组。
callBack该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

该类的文档由以下文件生成: