getAdvancedHistoryMessageListReverse
功能介绍
说明
按照时间从老到新,反向获取会话中的历史聊天记录,可用于定位消息上下文向下滚动时拉取历史消息。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<AdvancedMessage> getAdvancedHistoryMessageListReverse({
String? conversationID,
int? lastMinSeq,
Message? startMsg,
int? count,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | Sting | 是 | 会话 ID |
startMsg | Message | 是 | 从这条消息开始查询[count]条,获取的列表 index==length-1 为最新消息,所以获取下一页历史记录 startMsg=list.last |
count | int | 是 | 一次拉取的数量 |
lastMinSeq | int | 是 | 第一页消息不用传,获取第二页开始必传 跟[startMsg]一样 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | AdvancedMessage | 成功返回 |
代码示例
AdvancedMessage am = await OpenIM.iMManager.messageManager.getAdvancedHistoryMessageListReverse(
conversationID: '',
);
// todo
函数原型
- (void)getAdvancedHistoryMessageListReverse:(OIMGetAdvancedHistoryMessageListParam *)opts
onSuccess:(nullable OIMGetAdvancedHistoryMessageListCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
OIMGetAdvancedHistoryMessageListParam.conversationID | NSSting | 是 | 会话 ID,如果不为空则以会话 ID 获取,否则通过 userID 和 groupID 获取 |
OIMGetAdvancedHistoryMessageListParam.startClientMsgID | NSString | 是 | 起始的消息 clientMsgID,第一次拉取为"" |
OIMGetAdvancedHistoryMessageListParam.count | NSInteger | 是 | 一次拉取的数量 |
OIMGetAdvancedHistoryMessageListParam.lastMinSeq | NSInteger | 是 | lastMinSeq 是上一次拉取回调给的值,上下文,第二次拉取需要回传 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | NSArray< OIMGetAdvancedHistoryMessageListInfo * > | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
OIMGetAdvancedHistoryMessageListParam *opts = [OIMGetAdvancedHistoryMessageListParam new];
opts.conversationID = @"";
opts.count = 30;
opts.lastMinSeq = @"";
[OIMManager.manager getAdvancedHistoryMessageListReverse:opts
onSuccess:^(OIMGetAdvancedHistoryMessageListInfo * _Nullable result) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase<AdvancedMessage> | 是 | 回调接口 |
conversationID | Sting | 是 | 会话 ID |
startMsg | Message | 是 | 从这条消息开始查询[count]条,获取的列表 index==length-1 为最新消息,所以获取下一页历史记录 startMsg=list.first |
count | int | 是 | 数量 |
代码示例
OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase<AdvancedMessage>() {
public void onError(int code, String error) {
}
public void onSuccess(AdvancedMessage data) {
}
} conversationID, startMsg, count);
函数原型
IMSDK.getAdvancedHistoryMessageListReverse({
lastMinSeq: number;
count: number;
startClientMsgID: string;
conversationID: string;
}, operationID?: string): Promise<WsResponse<AdvancedGetMessageResult>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
startClientMsgID | string | 是 | 起始的消息 clientMsgID,第一次拉取为"",后续为上一次拉取的最后一条消息的 clientMsgID |
count | number | 是 | 一次拉取的数量 |
lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值,上下文,第二次拉取需要回传 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<AdvancedGetMessageResult>> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.getAdvancedHistoryMessageListReverse({
lastMinSeq: 0,
count: 20,
startClientMsgID: '',
conversationID: 'conversationID',
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('getAdvancedHistoryMessageListReverse', operationID: string, {
lastMinSeq: number;
count: number;
startClientMsgID: string;
conversationID: string;
}): Promise<AdvancedGetMessageResult>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
conversationID | string | 是 | 会话 ID |
startClientMsgID | string | 是 | 起始的消息 clientMsgID,第一次拉取为"",后续为上一次拉取的最后一条消息的 clientMsgID |
count | number | 是 | 一次拉取的数量 |
lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值,上下文,第二次拉取需要回传 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<AdvancedGetMessageResult> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('getAdvancedHistoryMessageListReverse', IMSDK.uuid(), {
lastMinSeq: 0,
count: 20,
startClientMsgID: '',
conversationID: 'conversationID',
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.getAdvancedHistoryMessageListReverse({
lastMinSeq: number;
count: number;
startClientMsgID: string;
conversationID: string;
}, operationID: string): Promise<AdvancedGetMessageResult>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
startClientMsgID | string | 是 | 起始的消息 clientMsgID,第一次拉取为"",后续为上一次拉取的最后一条消息的 clientMsgID |
count | number | 是 | 一次拉取的数量 |
lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值,上下文,第二次拉取需要回传 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<AdvancedGetMessageResult> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.getAdvancedHistoryMessageListReverse({
lastMinSeq: 0,
count: 20,
startClientMsgID: '',
conversationID: 'conversationID',
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
public static void GetAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> cb, GetAdvancedHistoryMessageListParams getMessageOptions)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
cb | OnBase<AdvancedMessage> | 是 | 回调接口 |
getMessageOptions | GetAdvancedHistoryMessageListParams | 是 | 选项 |
代码示例
IMSDK.GetAdvancedHistoryMessageListReverse((advanceMessage,errCode,errMsg)=>{
},new GetAdvancedHistoryMessageListParams(){
});