Merge pull request #253 from JauneQ/main

docs: update new parameter for v3.8.3
openimsdk · Jan 17, 2025 · 3643ebc · 3643ebc
2 parents 8db2f0f + 749706d
commit 3643ebc
Show file tree

Hide file tree

Showing 6 changed files with 250 additions and 26 deletions.
diff --git 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<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
+```java showLineNumbers
+    public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> 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<AdvancedMessage>() {
             @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
@@ -119,8 +119,8 @@ opts.lastMinSeq = @"";
 
 ### 函数原型
 
-```dart showLineNumbers
- public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
+```java showLineNumbers
+ public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> 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<AdvancedMessage>() {
             @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);
 ```
 
 </TabItem>

diff --git a/docs/sdks/enum/viewType.mdx 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      | 搜索历史消息 |
+
+<Tabs
+groupId="sdks-language"
+values={[
+{ label: 'iOS', value: 'iOS', },
+{ label: 'Android', value: 'Android', },
+{ label: 'Flutter', value: 'Flutter', },
+{ label: 'uni-app', value: 'uni-app', },
+{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
+{ label: 'React-Native', value: 'React-Native', },
+{ label: 'Unity', value: 'Unity', },
+]
+}>
+
+<TabItem value="iOS">
+
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| ---------- | ------ |
+| History    | 0      |
+| Search     | 1      |
+
+</TabItem>
+
+<TabItem value="Flutter">
+
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+
+<TabItem value="Web">
+
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+<TabItem value="Android">
+
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+
+<TabItem value="uni-app">
+
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+
+<TabItem value="React-Native">
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+
+<TabItem value="Unity">
+### ViewType
+
+| 枚举值名称 | 枚举值 |
+| --------- | ------ |
+| History   | 0      |
+| Search    | 1      |
+
+</TabItem>
+
+</Tabs>
diff --git a/...-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx b/...-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx
@@ -119,22 +119,23 @@ opts.lastMinSeq = @"";
 
 ### Function Prototype
 
-```dart showLineNumbers
-    public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
+```java showLineNumbers
+    public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> 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<AdvancedMessage>() {
             @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/...-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx b/...-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx
@@ -121,8 +121,8 @@ opts.lastMinSeq = @"";
 
 ### Function Prototype
 
-```dart showLineNumbers
- public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
+```java showLineNumbers
+ public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> 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<AdvancedMessage>() {
             @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);
 ```
 
 </TabItem>

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
@@ -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            |
+
+<Tabs
+groupId="sdks-language"
+values={[
+{ label: 'iOS', value: 'iOS', },
+{ label: 'Android', value: 'Android', },
+{ label: 'Flutter', value: 'Flutter', },
+{ label: 'uni-app', value: 'uni-app', },
+{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
+{ label: 'React-Native', value: 'React-Native', },
+{ label: 'Unity', value: 'Unity', },
+]
+}>
+
+<TabItem value="iOS">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+<TabItem value="Flutter">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+<TabItem value="Web">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+<TabItem value="Android">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+<TabItem value="uni-app">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+<TabItem value="React-Native">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+<TabItem value="Unity">
+
+### ViewType
+
+| Enum Name | Enum Value |
+| --------- | ---------- |
+| History   | 0          |
+| Search    | 1          |
+
+</TabItem>
+
+</Tabs>