功能描述
消息扩展可以为消息增加 key/value 状态标识。基于消息扩展，我们可以实现投票、接龙、问卷调查等功能。
在投票场景，我们可以先通过
createCustomMessage (点击查看详情) 接口创建一条用于投票的自定义消息，其中 data 存储投票的标题和选项，然后用消息扩展 key 存储投票用户 ID，用消息扩展 value 存储投票用户选项，有了每个用户的投票选项，我们就可以动态计算出投票选项的用户占比。在接龙场景，我们可以先通过
createCustomMessage 接口创建一条用于接龙的自定义消息，其中 data 存储接龙的标题，然后用消息扩展 key 存储接龙用户 ID，用消息扩展 value 存储接龙信息。在问卷调查场景，我们可以先通过
createCustomMessage 接口创建一条用于问卷调查的自定义消息，其中 data 存储问卷调查的标题和选项，然后用消息扩展 key 存储问卷调查的用户 ID，用消息扩展 value 存储问卷调查信息。说明
该功能仅对旗舰版客户开放，购买 旗舰版套餐包 后可使用。
该功能需要先在 即时通信 IM 控制台 > 功能配置 > 登录与消息 > 消息扩展设置中开启。
社群（Community）和直播群（AVChatRoom）消息不支持该功能。
设置消息扩展
设置消息扩展接口入参详解如下：
属性 | 含义 | 说明 |
message | 消息对象 | 消息需满足三个条件： 消息必须是发送成功的状态。 消息不能是社群（Community）和直播群（AVChatRoom）消息。 |
extensions | 扩展列表 | 如果扩展 key 已经存在，则修改扩展的 value 信息，如果扩展 key 不存在，则新增扩展。 |
说明
1. 扩展 key 最大支持 100 字节，扩展 value 最大支持 1KB，单次最多支持设置 20 个扩展，单条消息最多可设置 300 个扩展。
2. 当多个用户同时设置或删除同一个扩展 key 时，只有第一个用户可以执行成功，其它用户会在设置回包收到 23001 错误码和的扩展信息，在收到错误码和扩展信息后，请按需重新发起设置操作。
3. 我们强烈建议不同的用户设置不同的扩展 key，这样大部分场景都不会冲突，例如投票、接龙、问卷调查，都可以把自己的 userID 作为扩展 key。
示例代码如下：
// 设置消息扩展const msgID = ''; // 需要扩展的消息idconst extensions = [{ extensionKey: 'testKey1', extensionValue: 'testValue3' },{ extensionKey: 'testKey2', extensionValue: 'testValue4' },]; // 消息扩展字段const setMessageExtensionsRes = await TencentImSDKPlugin.v2TIMManager.getMessageManager().setMessageExtensions(msgID, extensions); // 消息扩展字段if (setMessageExtensionsRes.code == 0) {// 设置消息扩展成功}
获取消息扩展
说明
如果没有网络，SDK 会直接返回本地缓存的消息扩展列表。
示例代码如下：
// 获取消息扩展const getMessageExtensionsRes =await TencentImSDKPlugin.v2TIMManager.getMessageManager().getMessageExtensions('msgId', // 需要获取扩展信息的消息id);if (getMessageExtensionsRes.code == 0) {// 获取消息扩展成功getMessageExtensionsRes.data?.forEach((element) {element.extensionKey; // 被更改的扩展字段keyelement.extensionValue; // 被更改的扩展字段values});}
删除消息扩展
示例代码如下：
// 删除消息扩展const msgID = ''; // 需要扩展的消息idconst extensions = ["testKey1"]; // 需要删除的扩展字段的key的列表const deleteMessageExtensionsRes = await TencentImSDKPlugin.v2TIMManager.getMessageManager().deleteMessageExtensions(msgID, extensions);if (deleteMessageExtensionsRes.code == 0) {// 删除消息扩展成功deleteMessageExtensionsRes.data?.map((element) => {element.extension; //消息扩展信息element.resultCode; //操作结果码element.resultInfo; //描述信息});}
消息扩展更新
如果您事先调用
addAdvancedMsgListener 添加了高级消息事件监听器，当消息扩展发生了新增或者更新，您会收到 onRecvMessageExtensionsChanged (点击查看详情) 回调，当消息扩展发生了删除，您会收到 onRecvMessageExtensionsDeleted (点击查看详情) 回调。示例代码如下：
//创建消息监听器const listener = {onRecvMessageExtensionsChanged: (msgID, extensions) => {// msgID 被更改的消息id// extensions 被更改的扩展字段列表},onRecvMessageExtensionsDeleted: (msgID, extensionKeys) => {// msgID 被删除扩展信息的消息id// extensionKeys 被删除扩展信息的key列表},};// 添加高级消息的事件监听器TencentImSDKPlugin.v2TIMManager.getMessageManager().addAdvancedMsgListener(listener: listener);