上云无忧 > 文档中心 > 环信IM即时通讯使用教程(Flutter) - 在线状态订阅
IM即时通讯
环信IM即时通讯使用教程(Flutter) - 在线状态订阅

文档简介:
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。 本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。 注意: 私有化版本不支持在线状态订阅。
*此产品及展示信息均由环信官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

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

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

注意

私有化版本不支持在线状态订阅。

技术原理

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

  • publishPresence:发布自定义在线状态;
  • subscribe:订阅用户的在线状态;
  • onPresenceStatusChanged 被订阅用户的在线状态变更时,订阅者收到监听回调;
  • unSubscribe:无需关注用户的在线状态时,取消订阅;
  • fetchSubscribedMembers 获取订阅列表;
  • fetchPresenceStatus 获取指定用户状态;

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

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

  1. 用户 A 订阅用户 B 的在线状态;
  2. 用户 B 的在线状态发生变更;
  3. 用户 A 收到 B 的状态变更通知。

效果如下图:

前提条件

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

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

实现方法

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

订阅指定用户的在线状态

默认情况下,你不关注任何其他用户的在线状态。你可以通过调用 EMPresenceManager#subscribe 方法订阅指定用户的在线状态,示例代码如下:

// members: 要订阅的用户列表 List<String> members = []; // expiry: 过期时长,单位为秒
 int expiry = 100; try { List<EMPresence> list = await EMClient.getInstance.presenceManager.subscribe
( members: members, expiry: expiry, ); } on EMError catch (e) { // subscribe failed, code: e.code, reason: e.description } 
 

在线状态变更时,订阅者会收到 EMPresenceEventHandler#onPresenceStatusChanged 回调。

注意

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

发布自定义在线状态

用户在线时,可调用 EMPresenceManager#publishPresence 方法发布自定义在线状态:

try { // description: 状态描述 await EMClient.getInstance.presenceManager.
publishPresence(description); } on EMError catch (e) { } 
 

在线状态发布后,发布者和订阅者均会收到 EMPresenceEventHandler#onPresenceStatusChanged 事件。

添加在线状态监听器

添加用户在线状态的监听器以及接收状态变更事件通知,示例代码如下:

// 添加状态变化监听 EMClient.getInstance.presenceManager.addEventHandler( "UNIQUE_HANDLER_ID",
 EMPresenceEventHandler(), ); // 移除状态变化监听 EMClient.getInstance.presenceManager.removeEventHandler("UNIQUE_HANDLER_ID"); 
 

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

若取消指定用户的在线状态订阅,可调用 EMPresenceManager#unSubscribe 方法,示例代码如下:

// members: 将要取消订阅的用户列表 try { await EMClient.getInstance.presenceManager.unSubscribe
( members: members, ); } on EMError catch (e) { } 
 

查询被订阅用户列表

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

try { List<String> subMembers = await EMClient.getInstance.presenceManager.fetchSubscribedMembers(
); } on EMError catch (e) { // fetch subscribed members failed, code: e.code, reason: e.description } 
 

获取用户的当前在线状态

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

// memberIds: 要查询状态的用户 ID try { List<EMPresence> list = await EMClient.getInstance.
presenceManager .fetchPresenceStatus(members: memberIds); } on EMError catch (e) { }

相似文档
  • 环信即时通讯 IM 提供消息表情回复(下文统称 “Reaction”)功能。用户可以在单聊和群聊中对消息添加、删除表情。表情可以直观地表达情绪,利用 Reaction 可以提升用户的使用体验。同时在群组中,利用 Reaction 可以发起投票,根据不同表情的追加数量来确认投票。
  • 子区是群组成员的子集,是支持多人沟通的即时通讯系统,子区让用户能够在群组中的特定消息上创建单独的会话,以保持主聊天界面整洁。 本文介绍如何使用环信即时通讯 IM Flutter SDK 在实时互动 app 中创建和管理子区,并实现子区相关功能。
  • 子区消息消息类型属于群聊消息类型,与普通群组消息的区别是需要添加 isChatThread 标记。本文介绍即时通讯 IM Flutter SDK 如何发送、接收以及撤回子区消息。
  • 环信即时通讯 IM SDK 提供消息举报接口。开发者可以在客户端调用该接口举报违规消息。当服务器端审核服务收到举报消息后,会将举报消息存储到数据库,并在 Console 展示。审核员可在 Console 查看举报记录,并进行相应处理。
  • 本文介绍如何快速集成环信即时通讯 IM Unity SDK 实现发送和接收单聊文本消息。 技术原理: 下图展示在客户端发送和接收单聊文本消息的工作流程。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部