• IMLib / IMKit >
 
• 无 UI SDK（IMLib） >
 
• 消息相关 >
 
• 消息扩展

适用场景

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

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

设置消息可扩展

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

代码示例

 
RCIMIWImageMessage? message = await engine.createImageMessage(
      type,
      targetId,
      channelId,
      path,
    );
message?.expansion = {};
              

                
已复制
                复制代码
              
              
1
2
3
4
5
6
7

更新消息扩展信息

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

方法

 
Future<int> updateMessageExpansion(String messageUId, Map expansion, {IRCIMIWUpdateMessageExpansionCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWUpdateMessageExpansionCallback? callback = IRCIMIWUpdateMessageExpansionCallback(onMessageExpansionUpdated: (int? code) {
//...
});

int? ret = await engine?.updateMessageExpansion(messageUId, expansion, callback:callback);
              

                
已复制
                复制代码
              
              
1
2
3
4
5

回调方法

• onMessageExpansionUpdated

  接口调用结果的监听

 
Function(int? code, String? messageUId, Map? expansion)? onMessageExpansionUpdated;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onMessageExpansionUpdated = (int? code, String? messageUId, Map? expansion) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

删除消息扩展信息

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

方法

 
Future<int> removeMessageExpansionForKeys(String messageUId, List<String> keys, {IRCIMIWRemoveMessageExpansionForKeysCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWRemoveMessageExpansionForKeysCallback? callback = IRCIMIWRemoveMessageExpansionForKeysCallback(onMessageExpansionForKeysRemoved: (int? code) {
//...
});

int? ret = await engine?.removeMessageExpansionForKeys(messageUId, keys, callback:callback);
              

                
已复制
                复制代码
              
              
1
2
3
4
5

回调方法

• onMessageExpansionForKeysRemoved

接口调用结果的监听

 
Function(int? code, String? messageUId, List<String>? keys)? onMessageExpansionForKeysRemoved;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onMessageExpansionForKeysRemoved = (int? code, String? messageUId, List<String>? keys) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

消息扩展更新监听

方法

 
Function(Map? expansion, RCIMIWMessage? message)? onRemoteMessageExpansionUpdated;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onRemoteMessageExpansionUpdated = (Map? expansion, RCIMIWMessage? message) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

消息扩展移除监听

方法

 
Function(RCIMIWMessage? message, List<String>? keys)? onRemoteMessageExpansionForKeyRemoved;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onRemoteMessageExpansionForKeyRemoved = (RCIMIWMessage? message, List<String>? keys) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3