在线状态订阅

更新时间：2022-06-22

用户在线状态（即 Presence）包含用户的在线、离线以及自定义状态。

本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。

环信 IM SDK 提供 IEMPresenceManager、EMPresence 和 EMPresenceManagerDelegate类，用于管理在线状态订阅，包含如下核心方法：

• subscribe：订阅用户的在线状态；
• publishPresenceWithDescription：发布自定义在线状态；
• addListener：添加在线状态监听器；
• presenceStatusDidChanged：被订阅用户的在线状态变更时，订阅者收到监听回调；
• unsubscribe：无需关注用户的在线状态时，取消订阅。

订阅用户在线状态的基本工作流程如下：

如上图所示，订阅用户在线状态的基本步骤如下：

1、用户 A 订阅用户 B 的在线状态； 2、用户 B 的在线状态发生变更； 3、用户 A 收到 presenceStatusDidChanged 回调。

效果如下图：

使用在线状态功能前，请确保满足以下条件：

• 完成 3.9.1 以上版本 SDK 初始化，详见 快速开始。
• 了解环信即时通讯 IM API 的使用限制。
• 已联系商务开通在线状态订阅功能。

本节介绍如何使用环信 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，后续订阅也会成功，但默认会将订阅剩余时长较短的替代。

用户在线时，可调用 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 获取用户当前的在线状态，而无需订阅状态。示例代码如下：

[[EMClient sharedClient] presenceManager] fetchPresenceStatus:@[@"Alice",@"Tom"] completion:^(NSArray<EMPresence*>* presences,EMError*error){
    }];
}