• UIKit
  • SDK
  • 服务端 API
Chat/
SDK/
Flutter/
消息/
SDK
  • 安装即时通信 IM SDK
    • 安装
  • 初始化即时通信 IM SDK
    • 初始化
  • 登录和注销
    • 登录和注销
  • 消息
    • 消息概述
    • 发送消息
    • 接收消息
    • 历史消息
    • 转发消息
    • 修改消息
    • 消息插入
    • 删除消息
    • 清空消息
    • 撤回消息
    • 在线消息
    • 已读回执
    • 查询消息
    • 群 @ 消息
    • 定向群消息
    • 通知免打扰
    • 消息扩展
  • 会话
    • 会话概述
    • 会话列表
    • 获取会话
    • 未读会话数
    • 置顶会话
    • 删除会话
    • 会话草稿
    • 会话组
  • 群组
    • 群组概述
    • 群组管理
    • 群资料
    • 群成员管理
    • 群成员资料
    • 自定义群属性
  • 用户
    • 用户资料
    • 好友管理
    • 好友列表
    • 黑名单
  • 离线推送
    • 离线推送
  • 信令
    • 信令管理
  • 局部搜索
    • 查找消息
    • 查找好友
    • 查找群组
    • 查找群成员
  • 接口参考文档
    • 客户接口
  • 开发指引
  • 控制台指南
    • 创建和升级应用
    • 基本配置
    • 功能配置
    • 账号管理
    • 群组管理
    • 回调配置
  • 产品介绍
    • 消息管理
      • 单聊消息
      • 消息存储
      • 离线推送
      • 群消息
      • 消息格式
    • 账号系统
      • 登陆验证
      • 在线状态管理
    • 群相关
      • 群组系统
      • 群组管理
    • 用户资料和关系链
      • 资料管理
      • 关系链管理
  • 购买指南
    • 计费概述
    • 价格中心
  • 错误码

通知免打扰

功能描述

通过设置单聊和群聊的消息接收选项,可以实现消息免打扰的功能。 IM SDK 支持三种类型的消息接收选项,消息接收选项在 V2TIMReceiveMessageOpt 中定义:
消息接收选项
功能描述
ReceiveMsgOptEnum.V2TIM_RECEIVE_MESSAGE
在线时正常接收消息,离线时接收离线推送通知
ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE
在线和离线都不接收消息
ReceiveMsgOptEnum.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE
在线时正常接收消息,离线时不接收离线推送通知
使用不同的 V2TIMReceiveMessageOpt 可以实现群消息免打扰: 完全不接收消息 消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE 后,单聊/群聊的任何消息都收不到,会话列表也不会更新。
接收消息但不提醒,在会话列表界面显示小圆点(不显示未读数)
1. 消息接收选项设置为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE
2. 当单聊/群聊收到新消息,会话列表需要更新时,可以通过会话 V2TIMConversation 中的 unreadCount (Details) 获取到消息未读数。
3. 根据 V2TIMConversationrecvOpt (Details) 判断获取到的消息接收选项为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE 时显示小红点而非消息未读数。
说明:
此方式需使用未读计数功能,因此仅适用于好友工作群(Work)和陌生人社交群(Public)。群组类型详见 群组介绍。

设置单聊的消息接收选项

通过调用 setC2CReceiveMessageOpt(Details) 接口,设置单聊的消息接收选项。 您可以通过参数 userIDList 设置一批用户,但一次最大允许设置 30 个用户。
注意:
该接口调用频率被限制为 1 秒内最多调用 5 次。
示例代码如下:
// 设置在线和离线都不接收消息

TencentImSDKPlugin.v2TIMManager.getMessageManager().setC2CReceiveMessageOpt(userIDList: ['user1','user2'], opt: ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE);

获取单聊的消息接收选项

通过调用 getC2CReceiveMessageOpt(Details) 接口,获取单聊的消息接收选项。
示例代码如下:
V2TimValueCallback<List<V2TimReceiveMessageOptInfo>> messageOpt = await TencentImSDKPlugin.v2TIMManager.getMessageManager().getC2CReceiveMessageOpt(userIDList: ['user1','user2']);
messageOpt.data.forEach((element) {
// 接收消息选项
element.c2CReceiveMessageOpt;
element.userID;
});

设置群聊的消息接收选项

通过调用 setGroupReceiveMessageOpt(Details) 接口,设置群聊的消息接收选项。
示例代码如下:
TencentImSDKPlugin.v2TIMManager.getMessageManager().setGroupReceiveMessageOpt(groupID: "groupID", opt: ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE);

获取群聊的消息接收选项

通过调用 getGroupsInfo(Details) 接口,获得群资料 V2TIMGroupInfo 对象列表,对象的 recvOpt 字段表示群组的消息接收选项。
示例代码如下:
V2TimValueCallback<List<V2TimGroupInfoResult>> groups = await TencentImSDKPlugin.v2TIMManager.getGroupManager().getGroupsInfo(groupIDList: ['groupID']);
groups.data.forEach((element) {
// 获取群组的接收消息选项
element.groupInfo.recvOpt;
});