消息扩展

适用场景

原始消息增加状态标识的需求，都可使用消息扩展。

• 消息评论需求，可通过设置原始消息扩展信息的方式添加评论信息。
• 礼物领取、订单状态变化需求，通过此功能改变消息显示状态。 例如：向用户发送礼物，默认为未领取状态，用户点击后可设置消息扩展为已领取状态。
• 通过该功能可以对 message 设置扩展信息。
• 仅支持单聊、群聊会话类型，不支持聊天室类型。
• 每次设置消息扩展将会产生内置通知消息，频繁设置扩展会产生大量消息。

设置消息可扩展

在 [构建消息] 之后设置 message 的 expansion 属性，默认为不开启，设置值之后会自动开启。在发送消息的时候可以设置，发出去之后不可更改。

代码示例

let message = await engine.createImageMessage(
      type,
      targetId,
      channelId,
      path,
    );
// 设置空值可表示开启扩展
message.expansion = {};

更新消息扩展信息

1. 更新消息扩展信息。
2. 消息发送后调用。

方法

updateMessageExpansion(
  messageUId: string,
  expansion: Map<string, string>,
  callback: IRCIMIWUpdateMessageExpansionCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
messageUId	string	消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值
expansion	Map<string, string>	要更新的消息扩展信息键值对，类型是 HashMap；Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，不支持汉字。Value 可以输入空格
callback	IRCIMIWUpdateMessageExpansionCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onMessageExpansionUpdated:(res) => {
//...
}};
let code = await engine.updateMessageExpansion(messageUId, expansion, callback);

回调方法

• setOnMessageExpansionUpdatedListener

  接口调用结果的监听

setOnMessageExpansionUpdatedListener(listener?: ({code, messageUId, expansion}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
messageUId	string	消息的 messageUid
expansion	Map<string, string>	要更新的消息扩展信息键值对，类型是 HashMap

代码示例

engine.setOnMessageExpansionUpdatedListener((res) => {
    //...
});

删除消息扩展信息

1. 删除消息扩展信息中特定的键值对。
2. 消息发送后调用。

方法

removeMessageExpansionForKeys(
  messageUId: string,
  keys: Array<string>,
  callback: IRCIMIWRemoveMessageExpansionForKeysCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
messageUId	string	消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值
keys	Array<string>	消息扩展信息中待删除的 key 的列表，类型是 ArrayList
callback	IRCIMIWRemoveMessageExpansionForKeysCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onMessageExpansionForKeysRemoved:(res) => {
//...
}};
let code = await engine.removeMessageExpansionForKeys(messageUId, keys, callback);

回调方法

• setOnMessageExpansionForKeysRemovedListener

接口调用结果的监听

setOnMessageExpansionForKeysRemovedListener(listener?: ({code, messageUId, keys}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
messageUId	string	消息的 messageUid
keys	Array<string>	消息扩展信息中待删除的 key 的列表，类型是 ArrayList

代码示例

engine.setOnMessageExpansionForKeysRemovedListener((res) => {
    //...
});

消息扩展更新监听

方法

setOnRemoteMessageExpansionUpdatedListener(listener?: ({expansion, message}) => void): void;

参数说明

参数名	参数类型	描述
expansion	Map<string, string>	消息扩展信息中更新的键值对，只包含更新的键值对，不是全部的数据。如果想获取全部的键值对，请使用 message 的 expansion 属性。
message	RCIMIWMessage	发生变化的消息

代码示例

engine.setOnRemoteMessageExpansionUpdatedListener((res) => {
    //...
});

消息扩展移除监听

方法

setOnRemoteMessageExpansionForKeyRemovedListener(listener?: ({message, keys}) => void): void;

参数说明

参数名	参数类型	描述
message	RCIMIWMessage	发生变化的消息
keys	Array<string>	消息扩展信息中删除的键值对 key 列表

代码示例

engine.setOnRemoteMessageExpansionForKeyRemovedListener((res) => {
    //...
});