跳到主要内容

扩展消息

已发送的超级群消息可增加、修改、删除扩展信息。 原始消息增加状态标识的需求,都可使用消息扩展。

  • 消息评论需求,可通过设置原始消息扩展信息的方式添加评论信息。
  • 礼物领取、订单状态变化需求,通过此功能改变消息显示状态。 例如:向用户发送礼物,默认为未领取状态,用户点击后可设置消息扩展为已领取状态。

更新消息扩展

方法

updateUltraGroupMessageExpansion(
messageUId: string,
expansion: Map<string, string>,
callback: IRCIMIWUpdateUltraGroupMessageExpansionCallback
): Promise<number>;

参数说明

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

返回值

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

代码示例

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

回调方法

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

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
expansionMap<string, string>更新的消息扩展信息键值对
messageUIdstring消息的 messageUid

代码示例

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

删除消息扩展

方法

removeUltraGroupMessageExpansionForKeys(
messageUId: string,
keys: Array<string>,
callback: IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback
): Promise<number>;

参数说明

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

返回值

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

代码示例

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

回调方法

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

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageUIdstring消息的 messageUid
keysArray<string>消息扩展信息中待删除的 key 的列表

代码示例

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

监听远端消息扩展更新

当远端消息的扩展信息被更新时,会回调此方法。

方法

setOnRemoteUltraGroupMessageExpansionUpdatedListener(listener?: ({messages}) => void): void;

参数说明

参数名参数类型描述
messagesArray<RCIMIWMessage>被更新的消息集合

代码示例

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