• IMLib / IMKit >
 
• 无 UI SDK（IMLib） >
 
• 消息相关 >
 
• 获取历史消息

开通服务

从远端获取单群聊历史消息是指从融云服务端获取历史消息，该功能要求 App Key 已启用融云提供的单群聊消息云端存储服务。您可以在控制台 IM 服务管理页面为当前使用的 App Key 开启服务。如果使用生产环境的 App Key，请注意仅 IM 旗舰版或 IM 尊享版可开通该服务。具体功能与费用以融云官方价格说明页面及计费说明文档为准。

提示：请注意区分历史消息记录与离线消息^?。融云针对单聊、群聊、系统消息默认提供最多 7 天（可调整）的离线消息缓存服务。客户端上线时 SDK 会自动收取离线期间的消息，无需 App 层调用 API。详见管理离线消息存储配置。

获取历史消息

开发者可以通过此接口来获取某个会话的历史消息。

方法

 
Future<int> getMessages(RCIMIWConversationType type, String targetId, String? channelId, int sentTime, RCIMIWTimeOrder order, RCIMIWMessageOperationPolicy policy, int count, {IRCIMIWGetMessagesCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWGetMessagesCallback? callback = IRCIMIWGetMessagesCallback(onSuccess: (List<RCIMIWMessage>? t) {
//...
}, onError: (int? code) {
//...
});

int? ret = await engine?.getMessages(type, targetId, channelId, sentTime, order, policy, count, callback:callback);
              

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

回调方法

• onMessagesLoaded

 
Function(int? code, RCIMIWConversationType? type, String? targetId, String? channelId, int? sentTime, RCIMIWTimeOrder? order, List<RCIMIWMessage>? messages)? onMessagesLoaded;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onMessagesLoaded = (int? code, RCIMIWConversationType? type, String? targetId, String? channelId, int? sentTime, RCIMIWTimeOrder? order, List<RCIMIWMessage>? messages) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

通过 messageId 获取消息

开发者可以通过此接口来获取某条消息。

方法

 
Future<int> getMessageById(int messageId, {IRCIMIWGetMessageCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWGetMessageCallback? callback = IRCIMIWGetMessageCallback(onSuccess: (RCIMIWMessage? t) {
//...
}, onError: (int? code) {
//...
});

int? ret = await engine?.getMessageById(messageId, callback:callback);
              

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

通过 messageUId 获取消息

开发者可以通过此接口来获取某条消息。

方法

 
Future<int> getMessageByUId(String messageUId, {IRCIMIWGetMessageCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWGetMessageCallback? callback = IRCIMIWGetMessageCallback(onSuccess: (RCIMIWMessage? t) {
//...
}, onError: (int? code) {
//...
});

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

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