Chat SDK for Unity and Windows v1.2.0
Public 成员函数 | 所有成员列表
AgoraChat.PresenceManager类 参考
类 AgoraChat.PresenceManager 继承关系图:

Public 成员函数

void PublishPresence (string description, CallBack callback=null)
 
void SubscribePresences (List< string > members, long expiry, ValueCallBack< List< Presence > > callback=null)
 
void UnsubscribePresences (List< string > members, CallBack callback=null)
 
void FetchSubscribedMembers (int pageNum, int pageSize, ValueCallBack< List< string > > callback=null)
 
void FetchPresenceStatus (List< string > members, ValueCallBack< List< Presence > > callback=null)
 
void AddPresenceManagerDelegate (IPresenceManagerDelegate presenceManagerDelegate)
 
void RemovePresenceManagerDelegate (IPresenceManagerDelegate presenceManagerDelegate)
 

详细描述

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

成员函数说明

◆ PublishPresence()

void AgoraChat.PresenceManager.PublishPresence ( string  description,
CallBack  callback = null 
)

发布自定义在线状态。

参数
description在线状态描述信息,可以为空字符串。
callBack结果回调。如果该方法调用失败,会包含调用失败的原因。

◆ SubscribePresences()

void AgoraChat.PresenceManager.SubscribePresences ( List< string >  members,
long  expiry,
ValueCallBack< List< Presence > >  callback = null 
)

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

参数
members要订阅在线状态的用户 ID 数组。
expiry订阅时长,单位为秒,最长不超过 2,592,000 (30×24×3600) 秒,即 30 天。
callBack结果回调。如果该方法调用成功,会返回被订阅用户的当前状态,调用失败,会包含调用失败的原因。

◆ UnsubscribePresences()

void AgoraChat.PresenceManager.UnsubscribePresences ( List< string >  members,
CallBack  callback = null 
)

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

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

◆ FetchSubscribedMembers()

void AgoraChat.PresenceManager.FetchSubscribedMembers ( int  pageNum,
int  pageSize,
ValueCallBack< List< string > >  callback = null 
)

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

参数
pageNum当前页码,从 1 开始。
pageSize每页显示的被订阅用户数量。
callBack结果回调,返回订阅的在线状态所属的用户 ID。若当前未订阅任何用户的在线状态,返回空列表。

◆ FetchPresenceStatus()

void AgoraChat.PresenceManager.FetchPresenceStatus ( List< string >  members,
ValueCallBack< List< Presence > >  callback = null 
)

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

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

◆ AddPresenceManagerDelegate()

void AgoraChat.PresenceManager.AddPresenceManagerDelegate ( IPresenceManagerDelegate  presenceManagerDelegate)

添加在线状态监听器。

参数
listenerIPresenceManagerDelegate 要添加的在线状态监听器。

◆ RemovePresenceManagerDelegate()

void AgoraChat.PresenceManager.RemovePresenceManagerDelegate ( IPresenceManagerDelegate  presenceManagerDelegate)

移除在线状态监听器。

参数
listenerIPresenceManagerDelegate 要移除的在线状态监听器。