消息扩展

适用场景

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

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

设置消息可扩展

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

代码示例

engine.createImageMessage(type, targetId, channelId, path)
.then((message: RCIMIWImageMessage) => {
  message.expansion = {};
});

更新消息扩展信息

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

方法

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

参数说明

参数	类型	说明
expansion	Map<string, string>	消息扩展信息 1. 单次最大设置扩展信息键值对 20 对。 2.单条消息可设置最多 300 个扩展信息。 3. 仅支持单聊、群聊会话类型，不支持聊天室类型。
messageUId	string	消息唯一ID

代码示例

engine.updateMessageExpansion(
  messageUId,
  expansion
)
.then((code: number) => {});

回调方法

• setOnMessageExpansionUpdatedListener

  接口调用结果的监听

setOnMessageExpansionUpdatedListener(listener?: (code: number, messageUId: string, expansion: Map<string, string>) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
messageUId	string	调用接口时传入的 messageUId
expansion	Map<string, string>	调用接口时传入的expansion

代码示例

engine.setOnMessageExpansionUpdatedListener(
  (
    code: number,
    messageUId: string,
    expansion: Map<string, string>
  ) => {}
);

删除消息扩展信息

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

方法

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

参数说明

参数	类型	说明
keys	Array<String>	消息扩展信息中待删除的 key 的列表，类型是 List。
messageUId	string	消息唯一ID

代码示例

engine.removeMessageExpansionForKeys(
  messageUId,
  keys
)
.then((code: number) => {});

回调方法

• setOnMessageExpansionForKeysRemovedListener

  接口调用结果的监听

setOnMessageExpansionForKeysRemovedListener(listener?: (code: number, messageUId: string, keys: Array<string>) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
messageUId	string	调用接口时传入的messageUId
keys	Array<String>	调用接口时传入的 keys

代码示例

engine.setOnMessageExpansionForKeysRemovedListener(
  (
    code: number,
    messageUId: string,
    keys: Array<string>
  ) => {}
);

消息扩展更新监听

方法

setOnRemoteMessageExpansionUpdatedListener(listener?: (expansion: Map<string, string>, message: RCIMIWMessage) => void): void;

参数说明

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

代码示例

engine.setOnRemoteMessageExpansionUpdatedListener(
  (
    expansion: Map<string, string>,
    message: RCIMIWMessage
  ) => {}
);

消息扩展移除监听

方法

setOnRemoteMessageExpansionForKeyRemovedListener(listener?: (message: RCIMIWMessage, keys: Array<string>) => void): void;

参数说明

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

代码示例

engine.setOnRemoteMessageExpansionForKeyRemovedListener(
  (
    message: RCIMIWMessage,
    keys: Array<string>
  ) => {}
);