diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx index 77bd7a2d2e..9b0b689e36 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx @@ -119,22 +119,23 @@ opts.lastMinSeq = @""; ### 函数原型 -```dart showLineNumbers - public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | +| -------------- | -------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------| | callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 | | conversationID | Sting | 是 | 会话 ID | -| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | +| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | | count | int | 是 | 数量 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 | ### 代码示例 -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); // todo ``` diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx index c46158a8bf..0b788c4626 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -119,8 +119,8 @@ opts.lastMinSeq = @""; ### 函数原型 -```dart showLineNumbers - public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### 输入参数 @@ -129,12 +129,13 @@ opts.lastMinSeq = @""; | -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | | callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 | | conversationID | Sting | 是 | 会话 ID | -| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | +| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | | count | int | 是 | 数量 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 | ### 代码示例 -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); ``` diff --git a/docs/sdks/enum/viewType.mdx b/docs/sdks/enum/viewType.mdx new file mode 100644 index 0000000000..f46565a46a --- /dev/null +++ b/docs/sdks/enum/viewType.mdx @@ -0,0 +1,109 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# ViewType + +:::info + +在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList.mdx)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx)时，客户端用于通知SDK当前的具体操作。 + +::: + +## 当前操作类型 + +| 枚举值 | 描述 | +| ------ | ----------- | +| 0 | 拉取历史消息 | +| 1 | 搜索历史消息 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| ---------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx index b8737826ac..0a8c8d199b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx @@ -119,22 +119,23 @@ opts.lastMinSeq = @""; ### Function Prototype -```dart showLineNumbers - public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### Input Parameters -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------| -| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | -| conversationID | String | Yes | Conversation ID | -| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message | -| count | int | Yes | Number of messages | +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | ----------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------| +| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | +| conversationID | String | Yes | Conversation ID | +| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message | +| count | int | Yes | Number of messages | +| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. | ### Code Example -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); // todo ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx index 1637ec7281..1419bf03d7 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -121,8 +121,8 @@ opts.lastMinSeq = @""; ### Function Prototype -```dart showLineNumbers - public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count, ViewType) ``` ### Input Parameters @@ -131,12 +131,13 @@ opts.lastMinSeq = @""; | -------------- | -------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | | callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | | conversationID | Sting | Yes | Conversation ID | -| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Start querying [count] from this message. Index==length-1 is the latest message, so for the next page of historical records, startMsg=list.first | +| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Start querying [count] from this message. Index==length-1 is the latest message, so for the next page of historical records, startMsg=list.first | | count | int | Yes | Number of messages to retrieve in one fetch | +| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. | ### Code Example -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase() { @Override public void onError(int code, String error) { @@ -147,7 +148,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx new file mode 100644 index 0000000000..2dee217785 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx @@ -0,0 +1,111 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# ViewType + +:::info + +When use the api of [getAdvancedHistoryMessageList](/api/message/getAdvancedHistoryMessageList.mdx) or [getAdvancedHistoryMessageListReverse](/api/message/getAdvancedHistoryMessageListReverse.mdx), used to notify the SDK of the current specific operation. + +::: + +## Type of operation about get message list + +| Enum Value | Description | +| ---------- | ------------------------------------- | +| 0 | used for getting historical message | +| 1 | used for searching message | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + +