跳到主要内容

搜索消息

根据关键字搜索​

根据关键字搜索指定会话中的消息

方法​

Dart
Future<int> searchMessages(RCIMIWConversationType type, String targetId, String? channelId, String keyword, int startTime, int count, {IRCIMIWSearchMessagesCallback? callback});

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
keywordString搜索的关键字
startTimeint查询 beginTime 之前的消息， 传 0 时从最新消息开始搜索，从该时间往前搜索。
countint定义查询的数量，有效范围从0开始，上限为50（包含50）。
callbackIRCIMIWSearchMessagesCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

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

代码示例​

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

int? ret = await engine?.searchMessages(type, targetId, channelId, keyword, startTime, count, callback:callback);

根据关键字搜索指定会话中某个时间段的消息​

方法​

Dart
Future<int> searchMessagesByTimeRange(RCIMIWConversationType type, String targetId, String? channelId, String keyword, int startTime, int endTime, int offset, int count, {IRCIMIWSearchMessagesByTimeRangeCallback? callback});

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
keywordString搜索的关键字
startTimeint开始时间
endTimeint结束时间
offsetint偏移量
countint返回的搜索结果数量，有效范围从0开始，上限为50（包含50）。
callbackIRCIMIWSearchMessagesByTimeRangeCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

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

代码示例​

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

int? ret = await engine?.searchMessagesByTimeRange(type, targetId, channelId, keyword, startTime, endTime, offset, count, callback:callback);

根据用户 id 搜索指定会话中的消息​

方法​

Dart
Future<int> searchMessagesByUserId(String userId, RCIMIWConversationType type, String targetId, String? channelId, int startTime, int count, {IRCIMIWSearchMessagesByUserIdCallback? callback});

参数说明​

参数名参数类型描述
userIdString用户 id
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
startTimeint查询记录的起始时间， 传 0 时从最新消息开始搜索，从该时间往前搜索。
countint返回的搜索结果数量，有效范围从0开始，上限为50（包含50）。
callbackIRCIMIWSearchMessagesByUserIdCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

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

代码示例​

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

int? ret = await engine?.searchMessagesByUserId(userId, type, targetId, channelId, startTime, count, callback:callback);

回调方法​

  • onMessagesSearchedByUserId

    接口调用结果的监听

Dart
Function(int? code, String? userId, RCIMIWConversationType? type, String? targetId, String? channelId, int? startTime, int? count, List<RCIMIWMessage>? messages)? onMessagesSearchedByUserId;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
userIdString用户 id
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
startTimeint查询记录的起始时间
countint查询的数量
messagesList<RCIMIWMessage>查询到的消息集合

代码示例

Dart
engine?.onMessagesSearchedByUserId = (int? code, String? userId, RCIMIWConversationType? type, String? targetId, String? channelId, int? startTime, int? count, List<RCIMIWMessage>? messages) {
//...
};

根据关键字搜索指定消息类型的消息​

根据关键字搜索指定会话中，指定消息类型的本地历史消息

方法​

Dart
Future<int> searchMessagesByMessageTypes(RCIMIWConversationType type, String targetId, String? channelId, List<RCIMIWMessageType> messageTypes, String keyword, int startTime, int count, {IRCIMIWSearchMessagesByMessageTypesCallback? callback});

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
messageTypesList<RCIMIWMessageType>消息类型集合
keywordString搜索的关键字，非空
startTimeint查询 startTime 之前的消息（传 0 表示从最新消息开始搜索），单位：毫秒
countint最大的查询数量，最大 100。
callbackIRCIMIWSearchMessagesByMessageTypesCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值​

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

代码示例​

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

int? ret = await engine?.searchMessagesByMessageTypes(type, targetId, channelId, messageTypes, keyword, startTime, count, callback:callback);

回调方法​

  • onMessagesSearchedByMessageTypes

    接口调用结果的监听

Dart
Function(int? code, RCIMIWConversationType? type, String? targetId, String? channelId, List<RCIMIWMessageType>? messageTypes, String? keyword, int? startTime, int? count, List<RCIMIWMessage>? messages)? onMessagesSearchedByMessageTypes;

参数说明

参数名参数类型描述
codeint接口回调的状态码，0 代表成功，非 0 代表出现异常
typeRCIMIWConversationType会话类型
targetIdString会话 ID
channelIdString频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
messageTypesList<RCIMIWMessageType>消息类型集合
keywordString搜索的关键字
startTimeint查询 startTime 之前的消息
countint查询的数量
messagesList<RCIMIWMessage>查询到的消息集合

代码示例

Dart
engine?.onMessagesSearchedByMessageTypes = (int? code, RCIMIWConversationType? type, String? targetId, String? channelId, List<RCIMIWMessageType>? messageTypes, String? keyword, int? startTime, int? count, List<RCIMIWMessage>? messages) {
//...
};
最后于 更新