getAdvancedHistoryMessageList

Description

info

Get historical chat records in a conversation in chronological order (from new to old), such as loading historical messages when scrolling up.

iOS

Function Prototype

  Future<AdvancedMessage> getAdvancedHistoryMessageList({
    String? conversationID,
    int? lastMinSeq,
    Message? startMsg,
    int? count,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	Sting	Yes	Conversation ID
startMsg	Message	Yes	Search [count] messages starting from this message. The retrieved list index==length-1 is the latest message, so to get the next page of history startMsg=list.first
count	int	Yes	Amount
lastMinSeq	int	Yes	Do not pass for the first page. Required when fetching from the second page onwards, works together with [startMsg]

Return Result

Name	Type	Description
~	AdvancedMessage	Success return

Code Example

    AdvancedMessage am = await OpenIM.iMManager.messageManager.getAdvancedHistoryMessageList(
      conversationID: '',
    );
    // todo

Android

Function Prototype

- (void)getAdvancedHistoryMessageList:(OIMGetAdvancedHistoryMessageListParam *)opts
                            onSuccess:(nullable OIMGetAdvancedHistoryMessageListCallback)onSuccess
                            onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
OIMGetAdvancedHistoryMessageListParam.conversationID	NSSting	Yes	Conversation ID, if not empty, get by conversation ID, otherwise get by userID and groupID
OIMGetAdvancedHistoryMessageListParam.startClientMsgID	NSString	Yes	Starting message clientMsgID, empty string for first pull
OIMGetAdvancedHistoryMessageListParam.count	NSInteger	Yes	Amount to pull at once
OIMGetAdvancedHistoryMessageListParam.lastMinSeq	NSInteger	Yes	lastMinSeq is the value returned from the last pull callback, context used, needs to be passed back on the second pull

Return Result

Name	Type	Description
onSuccess	NSArray< OIMGetAdvancedHistoryMessageListInfo * >	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

OIMGetAdvancedHistoryMessageListParam *opts = [OIMGetAdvancedHistoryMessageListParam new];
opts.conversationID = @"";
opts.count = 30;
opts.lastMinSeq = @"";

[OIMManager.manager getAdvancedHistoryMessageList:opts
                                        onSuccess:^(OIMGetAdvancedHistoryMessageListInfo * _Nullable result) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

Function Prototype

    public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count, ViewType viewType)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase<AdvancedMessage>	Yes	Callback interface
conversationID	Sting	Yes	Conversation ID
startMsg	Message	Yes	Search [count] messages starting from this message. The retrieved list index==length-1 is the latest message, so to get the next page of history startMsg=list.first
count	int	Yes	Amount
viewType	ViewType	Yes	If it's History, it indicates currently getting historical messages; if it's Search, it indicates performing a search message operation

Code Example

        OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase<AdvancedMessage>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(AdvancedMessage data) {

            }
        } conversationID,  startMsg,  count, ViewType.History);
    // todo

uni-app

Function Prototype

enum ViewType {
  History = 0,
  Search = 1,
}
IMSDK.getAdvancedHistoryMessageList({
  viewType: ViewType;
  count: number;
  startClientMsgID: string;
  conversationID: string;
}, operationID?: string): Promise<WsResponse<AdvancedGetMessageResult>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	string	Yes	Conversation ID
startClientMsgID	string	Yes	Starting message clientMsgID, empty string for first pull, subsequently the clientMsgID of the last message from the previous pull
count	number	Yes	Amount to pull at once
viewType	ViewType	Yes	Determine whether it is a normal pull of chat history or getting message context after a search. The open-source version only supports pulling chat history (viewType is 0)

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<AdvancedGetMessageResult>>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

import { getSDK, ViewType } 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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.getAdvancedHistoryMessageList({
  viewType: ViewType.History,
  count: 20,
  startClientMsgID: '',
  conversationID: 'conversationID',
})
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('getAdvancedHistoryMessageList', operationID: string, {
  lastMinSeq: number;
  count: number;
  startClientMsgID: string;
  conversationID: string;
}): Promise<AdvancedGetMessageResult>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
conversationID	string	Yes	Conversation ID
startClientMsgID	string	Yes	Starting message clientMsgID, empty string for first pull, subsequently the clientMsgID of the last message from the previous pull
count	number	Yes	Amount to pull at once
lastMinSeq	number	Yes	lastMinSeq is the value returned from the last pull callback, context used, needs to be passed back on the second pull

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<AdvancedGetMessageResult>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getAdvancedHistoryMessageList', IMSDK.uuid(), {
  lastMinSeq: 0,
  count: 20,
  startClientMsgID: '',
  conversationID: 'conversationID',
})
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.getAdvancedHistoryMessageList({
  lastMinSeq: number;
  count: number;
  startClientMsgID: string;
  conversationID: string;
}, operationID?: string): Promise<AdvancedGetMessageResult>

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	string	Yes	Conversation ID
startClientMsgID	string	Yes	Starting message clientMsgID, empty string for first pull, subsequently the clientMsgID of the last message from the previous pull
count	number	Yes	Amount to pull at once
viewType	ViewType	Yes	Determine whether it is a normal pull of chat history or getting message context after a search
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<AdvancedGetMessageResult>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.getAdvancedHistoryMessageList({
  lastMinSeq: 0,
  count: 20,
  startClientMsgID: '',
  conversationID: 'conversationID',
})
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static void GetAdvancedHistoryMessageList(OnBase<AdvancedMessage> cb, GetAdvancedHistoryMessageListParams getMessageOptions)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase<AdvancedMessage>	Yes	Callback interface
getMessageOptions	GetAdvancedHistoryMessageListParams	Yes	Options

Code Example

IMSDK.GetAdvancedHistoryMessageList((advanceMessage,errCode,errMsg)=>{

},new GetAdvancedHistoryMessageListParams(){

});