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

消息扩展

功能描述

消息扩展可以为消息增加 key/value 状态标识。基于消息扩展,我们可以实现投票、接龙、问卷调查等功能。
在投票场景,我们可以先通过 createCustomMessage (点击查看详情) 接口创建一条用于投票的自定义消息,其中 data 存储投票的标题和选项,然后用消息扩展 key 存储投票用户 ID,用消息扩展 value 存储投票用户选项,有了每个用户的投票选项,我们就可以动态计算出投票选项的用户占比。
在接龙场景,我们可以先通过 createCustomMessage 接口创建一条用于接龙的自定义消息,其中 data 存储接龙的标题,然后用消息扩展 key 存储接龙用户 ID,用消息扩展 value 存储接龙信息。
在问卷调查场景,我们可以先通过 createCustomMessage 接口创建一条用于问卷调查的自定义消息,其中 data 存储问卷调查的标题和选项,然后用消息扩展 key 存储问卷调查的用户 ID,用消息扩展 value 存储问卷调查信息。
说明:

该功能仅对旗舰版客户开放,购买旗舰版后可使用。
该功能仅SDK 4.1.8 及以上版本支持。
该功能需要先在 即时通信 IM 控制台 > 功能配置 > 登录与消息 > 消息扩展设置中开启。
社群(Community)和直播群(AVChatRoom)消息不支持该功能。

设置消息扩展

调用 setMessageExtensions (点击查看详情) 接口可以设置消息扩展,如果扩展 key 已经存在,则修改扩展的 value 信息,如果扩展 key 不存在,则新增扩展。
设置消息扩展接口入参详解如下:
属性
含义
说明
message
消息对象
消息需满足三个条件:
消息发送前需设置 supportMessageExtension (Flutter) 为 YES。
消息必须是发送成功的状态。
消息不能是社群(Community)和直播群(AVChatRoom)消息。
extensions
扩展列表
如果扩展 key 已经存在,则修改扩展的 value 信息,如果扩展 key 不存在,则新增扩展。

说明:
1. 扩展 key 最大支持 100 字节,扩展 value 最大支持 1KB,单次最多支持设置 20 个扩展,单条消息最多可设置 300 个扩展。
1. 当多个用户同时设置或删除同一个扩展 key 时,只有第一个用户可以执行成功,其它用户会在设置回包收到 23001 错误码和最新的扩展信息,在收到错误码和扩展信息后,请按需重新发起设置操作。
2. 我们强烈建议不同的用户设置不同的扩展 key,这样大部分场景都不会冲突,例如投票、接龙、问卷调查,都可以把自己的 userID 作为扩展 key。
示例代码如下:
// 设置消息扩展
V2TimValueCallback<List<V2TimMessageExtensionResult>>
setMessageExtensionsRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.setMessageExtensions(msgID: '', // 需要扩展的消息id
extensions: []); // 消息扩展字段
if (setMessageExtensionsRes.code == 0) {
// 设置消息扩展成功
}

获取消息扩展

调用 getMessageExtensions (点击查看详情) 接口获取消息扩展列表。
说明:
如果没有网络,SDK 会直接返回本地缓存的消息扩展列表。
示例代码如下:
// 获取消息扩展
V2TimValueCallback<List<V2TimMessageExtension>> getMessageExtensionsRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.getMessageExtensions(
msgID: '', // 需要获取扩展信息的消息id
);
if (getMessageExtensionsRes.code == 0) {
// 获取消息扩展成功
getMessageExtensionsRes.data?.forEach((element) {
element.extensionKey; // 被更改的扩展字段key
element.extensionValue; // 被更改的扩展字段values
});
}

删除消息扩展

调用 deleteMessageExtensions (点击查看详情) 接口删除指定消息扩展,如果 keys 字段填 null ,则会清空所有消息扩展。
示例代码如下:
// 删除消息扩展
V2TimValueCallback<List<V2TimMessageExtensionResult>>
deleteMessageExtensionsRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.deleteMessageExtensions(msgID: '', // 需要删除扩展的消息id
keys: []); // 需要删除的扩展字段的key的列表
if (deleteMessageExtensionsRes.code == 0) {
// 删除消息扩展成功
deleteMessageExtensionsRes.data?.forEach((element) {
element.extension; //消息扩展信息
element.resultCode; //操作结果码
element.resultInfo; //描述信息
});
}

消息扩展更新

如果您事先调用 addAdvancedMsgListener 添加了高级消息事件监听器,当消息扩展发生了新增或者更新,您会收到 onRecvMessageExtensionsChanged (点击查看详情) 回调,当消息扩展发生了删除,您会收到 onRecvMessageExtensionsDeleted (点击查看详情) 回调。
示例代码如下:
//创建消息监听器
V2TimAdvancedMsgListener listener = V2TimAdvancedMsgListener(
onRecvMessageExtensionsChanged:
(String msgID, List<V2TimMessageExtension> extensions) {
// msgID 被更改的消息id
// extensions 被更改的扩展字段列表
for (V2TimMessageExtension element in extensions) {
element.extensionKey; // 被更改的扩展字段key
element.extensionValue; // 被更改的扩展字段values
}
},
onRecvMessageExtensionsDeleted: (msgID, extensionKeys) {
// msgID 被删除扩展信息的消息id
// extensionKeys 被删除扩展信息的key列表
},
);
// 添加高级消息的事件监听器
TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.addAdvancedMsgListener(listener: listener);