获取历史消息

开通服务

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

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

提示

• 用户是否可以获取在加入群组之前的群聊历史消息取决于 App 在控制台的设置。您可以在控制台的免费基础功能页面，启用新用户获取加入群组前历史消息。启用此选项后，新入群用户可以获取在他们加入群组之前发送的所有群聊消息。如不启用，新入群用户只能看到他们入群后的群聊消息。
• 默认情况下，用户不在群组中不能获取群组中的历史消息。如果您希望用户未在指定群组中时，也可以获取群组历史消息，可以在融云控制台，通过应用配置>IM 服务>免费基础功能>单群聊>用户不在群组时是否可以拉取历史消息，允许不在群组的用户也可以获取该群组的的历史消息。

获取历史消息

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

方法

Dart

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

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型
targetId	String	会话 ID
channelId	String	频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
sentTime	int	当前消息时间戳
order	RCIMIWTimeOrder	获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）
policy	RCIMIWMessageOperationPolicy	消息的加载策略。LOCAL：只加载本地，REMOTE：只加载远端，LOCAL_REMOTE：本地远端都加载
count	int	获取的消息数量，count的范围：大于 0 且小于等于 20
callback	IRCIMIWGetMessagesCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例

Dart

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

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

通过 messageId 获取消息

开发者可以通过此接口来获取某条本地数据库的消息。

方法

Dart

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

参数说明

参数名	参数类型	描述
messageId	int	消息的 messageId，可在消息对象中获取
callback	IRCIMIWGetMessageCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例

Dart

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

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

通过 messageUId 获取消息

开发者可以通过此接口来获取某条本地数据库的消息。

方法

Dart

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

参数说明

参数名	参数类型	描述
messageUId	String	消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值。
callback	IRCIMIWGetMessageCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例

Dart

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

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

按消息类型获取本地消息

获取会话中指定类型的本地消息。

方法

Dart

Future<int> getLocalMessagesByMessageTypes(RCIMIWConversationType type, String targetId, String? channelId, List<RCIMIWMessageType> messageTypes, int sentTime, RCIMIWTimeOrder order, int count, {IRCIMIWGetMessagesCallback? callback});

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型
targetId	String	会话 ID
channelId	String	消息所属会话的业务标识，仅支持超级群使用，其他会话类型传 null 即可。
messageTypes	List<RCIMIWMessageType>	消息类型列表
sentTime	int	消息发送时间戳，0 表示最新的消息
order	RCIMIWTimeOrder	获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）
count	int	获取的消息数量
callback	IRCIMIWGetMessagesCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表调用成功 具体结果通过接口 callback 回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例

Dart

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

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

根据时间获取前后消息

在会话中获取指定消息的前后指定数量的消息。返回的消息列表中会包含指定的消息。消息列表时间顺序从新到旧。

方法

Dart

Future<int> getMessagesAroundTime(RCIMIWConversationType type, String targetId, String? channelId, int sentTime, int beforeCount, int afterCount, {IRCIMIWGetMessagesAroundTimeCallback? callback});

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型
targetId	String	会话 ID
channelId	String	消息所属会话的业务标识，仅支持超级群使用，其他会话类型传 null 即可。
sentTime	int	指定消息的发送时间，不能为 0。单位：毫秒
beforeCount	int	指定消息的前部分消息数量
afterCount	int	指定消息的后部分消息数量
callback	IRCIMIWGetMessagesAroundTimeCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表调用成功 具体结果通过接口 callback 回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例

Dart

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

int? ret = await engine?.getMessagesAroundTime(type, targetId, channelId, sentTime, beforeCount, afterCount, callback:callback);

回调方法

• onMessagesAroundTimeLoaded

Dart

Function(int? code, RCIMIWConversationType? type, String? targetId, String? channelId, int? sentTime, int? beforeCount, int? afterCount, List<RCIMIWMessage>? messages)? onMessagesAroundTimeLoaded;

参数说明

参数名	参数类型	描述
code	int	接口回调的状态码，0 代表成功，非 0 代表出现异常
type	RCIMIWConversationType	会话类型
targetId	String	会话 ID
channelId	String	消息所属会话的业务标识
sentTime	int	指定消息的发送时间
beforeCount	int	指定消息的前部分消息数量
afterCount	int	指定消息的后部分消息数量
messages	List<RCIMIWMessage>	获取到的消息集合

代码示例

Dart

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