搜索消息
根据关键字搜索
根据关键字搜索指定会话中的消息
方法
searchMessages(type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, count: number): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | string | 会话ID |
channelId | string | 暂不支持该参数。传 null 即可。 |
keyword | string | 搜索的关键字 |
startTime | number | 查询 beginTime 之前的消息, 传 0 时从最新消息开始搜索,从该时间往前搜索。 |
count | number | 查询的数量,count 大于 0,小于等于 50。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
let promise = main.engine?.searchMessages(conversationType, targetId, channelId, keyword, startTime, count)
.then((code: number) => {});
回调方法
- setOnMessagesSearchedListener
接口调用结果的监听
setOnMessagesSearchedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, count: number, messages: Array<RCIMIWMessage>) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表 出现异常 |
type | RCIMIWConversationType | 调用接口时传入的会话类型 |
targetId | string | 调用接口时传入的会话ID |
channelId | string | 调用接口时传入的频道 ID |
keyword | string | 调用接口时传入的关键字 |
startTime | number | 调用接口时传入的时间戳 |
count | number | 调用接口时传入的数量 |
messages | Array<RCIMIWMessage> | 查询到的消息集合 |
代码示例
engine.setOnMessagesSearchedListener(
(
code: number,
type: RCIMIWConversationType,
targetId: string,
channelId: string,
keyword: string,
startTime: number,
count: number,
messages: Array<RCIMIWMessage>
) => {}
);