管理在线状态订阅
管理在线状态订阅
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。
本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。
关于用户的在线、离线和自定义状态的定义、变更以及用户的实时感知,详见用户在线状态管理。
技术原理
环信 IM SDK 提供 IEMPresenceManager
、EMPresence
和 EMPresenceManagerDelegate
类,用于管理在线状态订阅,包含如下核心方法:
subscribe
:订阅用户的在线状态;publishPresenceWithDescription
:发布自定义在线状态;addListener
:添加在线状态监听器;presenceStatusDidChanged
:被订阅用户的在线状态变更时,订阅者收到监听回调;unsubscribe
:无需关注用户的在线状态时,取消订阅。
订阅用户在线状态的基本工作流程如下:
如上图所示,订阅用户在线状态的基本步骤如下:
1、用户 A 订阅用户 B 的在线状态; 2、用户 B 的在线状态发生变更; 3、用户 A 收到 presenceStatusDidChanged
回调。
效果如下图:
前提条件
使用在线状态功能前,请确保满足以下条件:
实现方法
本节介绍如何使用环信 IM SDK 提供的 API 实现上述功能。
订阅指定用户的在线状态
默认情况下,你不关注任何其他用户的在线状态。你可以通过调用 subscribe
方法订阅指定用户的在线状态,示例代码如下:
[[[EMClient sharedClient] presenceManager] subscribe:@[@"Alice",@"Bob"] expiry:7*24*3600 completion:^(NSArray<EMPresence *> *presences, EMError *error) {
}];
成功订阅指定用户的在线状态后,SDK 通过 completion
回调返回被订阅用户的在线状态。
在线状态变更时,订阅者会收到 presenceStatusDidChanged
回调。
提示
- 订阅时长最长为 30 天,过期需重新订阅。如果未过期的情况下重复订阅,新设置的有效期会覆盖之前的有效期。
- 每次调用接口最多只能订阅 100 个账号,若数量较大需多次调用。
- 每个用户 ID 订阅的用户数不超过 3000。如果超过 3000,后续订阅也会成功,但默认会将订阅剩余时长较短的替代。
- 每个用户最多可被 3000 个用户订阅。
发布自定义在线状态
用户在线时,可调用 publishPresenceWithDescription
方法发布自定义在线状态:
// 异步方法
[[[EMClient sharedClient] presenceManager] publishPresenceWithDescription:@"custom presence" completion:^(EMError *error) {
}];
在线状态发布后,发布者和订阅者均会收到 presenceStatusDidChanged
回调。
添加在线状态监听器
参考如下代码,添加用户在线状态的监听器:
[[[EMClient sharedClient] presenceManager] addDelegate:self delegateQueue:nil];
监听器实现以下代理方法:
- (void) presenceStatusDidChanged:(NSArray<EMPresence*>*)presences
{
NSLog(@"presenceStatusDidChanged:%@",presences);
}
取消订阅指定用户的在线状态
若取消指定用户的在线状态订阅,可调用 unsubscribe
方法,示例代码如下:
// 异步方法
[[[EMClient sharedClient] presenceManager] unsubscribe:@[@"Alice"] completion:^(EMError *error) {
}];
查询被订阅用户列表
为方便用户管理订阅关系,SDK 提供 fetchSubscribedMembersWithPageNum
方法,可使用户分页查询自己订阅的用户列表,示例代码如下:
// 异步方法
[[[EMClient sharedClient] presenceManager] fetchSubscribedMembersWithPageNum:0 pageSize:50 Completion:^(NSArray<NSString*>* members,EMError*error){
}];
获取用户的当前在线状态
如果不关注用户的在线状态变更,你可以调用 fetchPresenceStatus
获取用户当前的在线状态,而无需订阅状态。示例代码如下:
// 异步方法
// 每次最多可传 100 个用户 ID。
[[[EMClient sharedClient] presenceManager] fetchPresenceStatus:@[@"Alice",@"Tom"] completion:^(NSArray<EMPresence*>* presences,EMError*error){
}];