在线状态订阅 Android

更新时间：2022-06-22

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

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

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

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

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

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

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

效果如下图：

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

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

本节介绍如何使用环信 IM SDK 提供的 API 实现上述功能。

默认情况下，你不关注任何其他用户的在线状态。你可以通过调用 com.hyphenate.chat.EMPresenceManager#subscribePresences 方法订阅指定用户的在线状态，示例代码如下：

EMClient.getInstance().presenceManager().subscribePresences(contactsFromServer, 1 * 24 * 3600, new EMValueCallBack<List<EMPresence>>() {
                    @Override
                    public void onSuccess(List<EMPresence> presences) {
                        
                    }

                    @Override
                    public void onError(int errorCode, String errorMsg) {
                       
                    }
                });             

成功订阅指定用户的在线状态后，SDK 通过 onSuccess 回调返回被订阅用户的在线状态。

在线状态变更时，订阅者会收到 com.hyphenate.EMPresenceListener#onPresenceUpdated 回调。

注意

• 订阅时长最长为 30 天，过期需重新订阅。如果未过期的情况下重复订阅，新设置的有效期会覆盖之前的有效期。
• 每次调用接口最多只能订阅 100 个账号，若数量较大需多次调用。每个用户 ID 订阅的用户数不超过 3000。如果超过 3000，后续订阅也会成功，但默认会将订阅剩余时长较短的替代。

用户在线时，可调用 com.hyphenate.chat.EMPresenceManager#publishPresence 方法发布自定义在线状态：

EMClient.getInstance().presenceManager().publishPresence("自定义状态", new EMCallBack() {
                    @Override
                    public void onSuccess() {

                    }

                    @Override
                    public void onError(int code, String error) {

                    }
                });

在线状态发布后，发布者和订阅者均会收到 com.hyphenate.EMPresenceListener#onPresenceUpdated 回调。

添加用户在线状态的监听器，示例代码如下：

EMClient.getInstance().presenceManager().addListener(new MyPresenceListener());

参考如下示例代码，使用 EMPresenceListener 监听器实现以下接口。当订阅的用户在线状态发生变化时，会收到onPresenceUpdated 回调。

public interface EMPresenceListener {
    void onPresenceUpdated(List<EMPresence> presences);
}

若取消指定用户的在线状态订阅，可调用 com.hyphenate.chat.EMPresenceManager#unsubscribePresences 方法，示例代码如下：

EMClient.getInstance().presenceManager().unsubscribePresences(contactsFromServer, new EMCallBack() {
                    @Override
                    public void onSuccess() {
                       
                    }

                    @Override
                    public void onError(int errorCode, String errorMsg) {
                       
                    }
                });

为方便用户管理订阅关系，SDK 提供 com.hyphenate.chat.EMPresenceManager#fetchSubscribedMembers 方法，可使用户分页查询自己订阅的用户列表，示例代码如下：

EMClient.getInstance().presenceManager().fetchSubscribedMembers(1, 50, new EMValueCallBack<List<String>>() {
                    @Override
                    public void onSuccess(List<String> subscribedMembers) {
                        
                    }

                    @Override
                    public void onError(int errorCode, String errorMsg) {
                       
                    }
                });

如果不关注用户的在线状态变更，你可以调用 com.hyphenate.chat.EMPresenceManager#fetchPresenceStatus 获取用户当前的在线状态，而无需订阅状态。示例代码如下：

EMClient.getInstance().presenceManager().fetchPresenceStatus(contactsFromServer, new EMValueCallBack<List<EMPresence>>() {
                    @Override
                    public void onSuccess(List<EMPresence> presences) {
                        
                    }

                    @Override
                    public void onError(int errorCode, String errorMsg) {
                       
                    }
                });