扩展消息
已发送的超级群消息可增加、修改、删除扩展信息。 原始消息增加状态标识的需求,都可使用消息扩展。
- 消息评论需求,可通过设置原始消息扩展信息的方式添加评论信息。
- 礼物领取、订单状态变化需求,通过此功能改变消息显示状态。 例如:向用户发送礼物,默认为未领取状态,用户点击后可设置消息扩展为已领取状态。
更新消息扩展
方法
Future<int> updateUltraGroupMessageExpansion(String messageUId, Map expansion, {IRCIMIWUpdateUltraGroupMessageExpansionCallback? callback});
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
messageUId | String | 消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值 |
expansion | Ma<String, String> | 更新的消息扩展信息键值对,类型是 HashMap;Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,不支持汉字。Value 可以输入空格。 |
callback | IRCIMIWUpdateUltraGroupMessageExpansionCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
IRCIMIWUpdateUltraGroupMessageExpansionCallback? callback = IRCIMIWUpdateUltraGroupMessageExpansionCallback(onUltraGroupMessageExpansionUpdated: (int? code) {
//...
});
int? ret = await engine?.updateUltraGroupMessageExpansion(messageUId, expansion, callback:callback);
回调方法
- onUltraGroupMessageExpansionUpdated
Function(int? code, Map? expansion, String? messageUId)? onUltraGroupMessageExpansionUpdated;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | int | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
expansion | Ma<String, String> | 更新的消息扩展信息键值对 |
messageUId | String | 消息的 messageUid |
代码示例
engine?.onUltraGroupMessageExpansionUpdated = (int? code, Map? expansion, String? messageUId) {
//...
};
删除消息扩展
方法
Future<int> removeUltraGroupMessageExpansionForKeys(String messageUId, List<String> keys, {IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback? callback});
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
messageUId | String | 消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值 |
keys | List<String> | 消息扩展信息中待删除的 key 的列表,类型是 ArrayList |
callback | IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback? callback = IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback(onUltraGroupMessageExpansionForKeysRemoved: (int? code) {
//...
});
int? ret = await engine?.removeUltraGroupMessageExpansionForKeys(messageUId, keys, callback:callback);
回调方法
- onUltraGroupMessageExpansionForKeysRemoved
Function(int? code, String? messageUId, List<String>? keys)? onUltraGroupMessageExpansionForKeysRemoved;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | int | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
messageUId | String | 消息的 messageUid |
keys | List<String> | 消息扩展信息中待删除的 key 的列表 |
代码示例
engine?.onUltraGroupMessageExpansionForKeysRemoved = (int? code, String? messageUId, List<String>? keys) {
//...
};
监听远端消息扩展更新
当远端消息的扩展信息被更新时,会回调此方法。
方法
Function(List<RCIMIWMessage>? messages)? onRemoteUltraGroupMessageExpansionUpdated;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
messages | List<RCIMIWMessage> | 被更新的消息集合 |
代码示例
engine?.onRemoteUltraGroupMessageExpansionUpdated = (List<RCIMIWMessage>? messages) {
//...
};