Skip to content

Commit 3643ebc

Browse files
skiffer-gitskiffer-git
authored
Merge pull request #253 from JauneQ/main
docs: update new parameter for v3.8.3
2 parents 8db2f0f + 749706d commit 3643ebc

File tree

6 files changed

+250
-26
lines changed

6 files changed

+250
-26
lines changed

‎docs/sdks/api/message/getAdvancedHistoryMessageList.mdx‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,22 +119,23 @@ opts.lastMinSeq = @"";
119119

120120
### 函数原型
121121

122-
```dart showLineNumbers
123-
public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
122+
```java showLineNumbers
123+
public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count, ViewType viewType)
124124
```
125125

126126
### 输入参数
127127

128128
| 参数名称 | 参数类型 | 是否必填 | 描述 |
129-
| -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
129+
| -------------- | -------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------|
130130
| callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 |
131131
| conversationID | Sting | 是 | 会话 ID |
132-
| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
132+
| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
133133
| count | int | 是 | 数量 |
134+
| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 |
134135

135136
### 代码示例
136137

137-
```dart showLineNumbers
138+
```java showLineNumbers
138139
OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase<AdvancedMessage>() {
139140
@Override
140141
public void onError(int code, String error) {
@@ -145,7 +146,7 @@ opts.lastMinSeq = @"";
145146
public void onSuccess(AdvancedMessage data) {
146147

147148
}
148-
} conversationID, startMsg, count);
149+
} conversationID, startMsg, count, ViewType.History);
149150
// todo
150151
```
151152

‎docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ opts.lastMinSeq = @"";
119119

120120
### 函数原型
121121

122-
```dart showLineNumbers
123-
public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
122+
```java showLineNumbers
123+
public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count, ViewType viewType)
124124
```
125125

126126
### 输入参数
@@ -129,12 +129,13 @@ opts.lastMinSeq = @"";
129129
| -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
130130
| callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 |
131131
| conversationID | Sting | 是 | 会话 ID |
132-
| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
132+
| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
133133
| count | int | 是 | 数量 |
134+
| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 |
134135

135136
### 代码示例
136137

137-
```dart showLineNumbers
138+
```java showLineNumbers
138139
OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase<AdvancedMessage>() {
139140
@Override
140141
public void onError(int code, String error) {
@@ -145,7 +146,7 @@ opts.lastMinSeq = @"";
145146
public void onSuccess(AdvancedMessage data) {
146147

147148
}
148-
} conversationID, startMsg, count);
149+
} conversationID, startMsg, count, ViewType.History);
149150
```
150151

151152
</TabItem>

‎docs/sdks/enum/viewType.mdx‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
sidebar_position: 2
3+
toc_min_heading_level: 2
4+
toc_max_heading_level: 2
5+
---
6+
7+
# ViewType
8+
9+
:::info
10+
11+
在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList.mdx)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx)时，客户端用于通知SDK当前的具体操作。
12+
13+
:::
14+
15+
## 当前操作类型
16+
17+
| 枚举值 | 描述 |
18+
| ------ | ----------- |
19+
| 0 | 拉取历史消息 |
20+
| 1 | 搜索历史消息 |
21+
22+
<Tabs
23+
groupId="sdks-language"
24+
values={[
25+
{ label: 'iOS', value: 'iOS', },
26+
{ label: 'Android', value: 'Android', },
27+
{ label: 'Flutter', value: 'Flutter', },
28+
{ label: 'uni-app', value: 'uni-app', },
29+
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
30+
{ label: 'React-Native', value: 'React-Native', },
31+
{ label: 'Unity', value: 'Unity', },
32+
]
33+
}>
34+
35+
<TabItem value="iOS">
36+
37+
### ViewType
38+
39+
| 枚举值名称 | 枚举值 |
40+
| ---------- | ------ |
41+
| History | 0 |
42+
| Search | 1 |
43+
44+
</TabItem>
45+
46+
<TabItem value="Flutter">
47+
48+
### ViewType
49+
50+
| 枚举值名称 | 枚举值 |
51+
| --------- | ------ |
52+
| History | 0 |
53+
| Search | 1 |
54+
55+
</TabItem>
56+
57+
<TabItem value="Web">
58+
59+
### ViewType
60+
61+
| 枚举值名称 | 枚举值 |
62+
| --------- | ------ |
63+
| History | 0 |
64+
| Search | 1 |
65+
66+
</TabItem>
67+
<TabItem value="Android">
68+
69+
### ViewType
70+
71+
| 枚举值名称 | 枚举值 |
72+
| --------- | ------ |
73+
| History | 0 |
74+
| Search | 1 |
75+
76+
</TabItem>
77+
78+
<TabItem value="uni-app">
79+
80+
### ViewType
81+
82+
| 枚举值名称 | 枚举值 |
83+
| --------- | ------ |
84+
| History | 0 |
85+
| Search | 1 |
86+
87+
</TabItem>
88+
89+
<TabItem value="React-Native">
90+
### ViewType
91+
92+
| 枚举值名称 | 枚举值 |
93+
| --------- | ------ |
94+
| History | 0 |
95+
| Search | 1 |
96+
97+
</TabItem>
98+
99+
<TabItem value="Unity">
100+
### ViewType
101+
102+
| 枚举值名称 | 枚举值 |
103+
| --------- | ------ |
104+
| History | 0 |
105+
| Search | 1 |
106+
107+
</TabItem>
108+
109+
</Tabs>

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,22 +119,23 @@ opts.lastMinSeq = @"";
119119

120120
### Function Prototype
121121

122-
```dart showLineNumbers
123-
public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
122+
```java showLineNumbers
123+
public void getAdvancedHistoryMessageList(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count, ViewType viewType)
124124
```
125125

126126
### Input Parameters
127127

128-
| Parameter Name | Parameter Type | Mandatory | Description |
129-
| -------------- | ----------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------|
130-
| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface |
131-
| conversationID | String | Yes | Conversation ID |
132-
| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message |
133-
| count | int | Yes | Number of messages |
128+
| Parameter Name | Parameter Type | Mandatory | Description |
129+
| -------------- | ----------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------|
130+
| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface |
131+
| conversationID | String | Yes | Conversation ID |
132+
| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message |
133+
| count | int | Yes | Number of messages |
134+
| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. |
134135

135136
### Code Example
136137

137-
```dart showLineNumbers
138+
```java showLineNumbers
138139
OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase<AdvancedMessage>() {
139140
@Override
140141
public void onError(int code, String error) {
@@ -145,7 +146,7 @@ opts.lastMinSeq = @"";
145146
public void onSuccess(AdvancedMessage data) {
146147

147148
}
148-
} conversationID, startMsg, count);
149+
} conversationID, startMsg, count, ViewType.History);
149150
// todo
150151
```
151152

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ opts.lastMinSeq = @"";
121121

122122
### Function Prototype
123123

124-
```dart showLineNumbers
125-
public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count)
124+
```java showLineNumbers
125+
public void getAdvancedHistoryMessageListReverse(OnBase<AdvancedMessage> callBack, String conversationID, Message startMsg, int count, ViewType)
126126
```
127127

128128
### Input Parameters
@@ -131,12 +131,13 @@ opts.lastMinSeq = @"";
131131
| -------------- | -------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------- |
132132
| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface |
133133
| conversationID | Sting | Yes | Conversation ID |
134-
| 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 |
134+
| 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 |
135135
| count | int | Yes | Number of messages to retrieve in one fetch |
136+
| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. |
136137

137138
### Code Example
138139

139-
```dart showLineNumbers
140+
```java showLineNumbers
140141
OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase<AdvancedMessage>() {
141142
@Override
142143
public void onError(int code, String error) {
@@ -147,7 +148,7 @@ opts.lastMinSeq = @"";
147148
public void onSuccess(AdvancedMessage data) {
148149

149150
}
150-
} conversationID, startMsg, count);
151+
} conversationID, startMsg, count, ViewType.History);
151152
```
152153

153154
</TabItem>

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
sidebar_position: 2
3+
toc_min_heading_level: 2
4+
toc_max_heading_level: 2
5+
---
6+
7+
# ViewType
8+
9+
:::info
10+
11+
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.
12+
13+
:::
14+
15+
## Type of operation about get message list
16+
17+
| Enum Value | Description |
18+
| ---------- | ------------------------------------- |
19+
| 0 | used for getting historical message |
20+
| 1 | used for searching message |
21+
22+
<Tabs
23+
groupId="sdks-language"
24+
values={[
25+
{ label: 'iOS', value: 'iOS', },
26+
{ label: 'Android', value: 'Android', },
27+
{ label: 'Flutter', value: 'Flutter', },
28+
{ label: 'uni-app', value: 'uni-app', },
29+
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
30+
{ label: 'React-Native', value: 'React-Native', },
31+
{ label: 'Unity', value: 'Unity', },
32+
]
33+
}>
34+
35+
<TabItem value="iOS">
36+
37+
### ViewType
38+
39+
| Enum Name | Enum Value |
40+
| --------- | ---------- |
41+
| History | 0 |
42+
| Search | 1 |
43+
44+
</TabItem>
45+
46+
<TabItem value="Flutter">
47+
48+
### ViewType
49+
50+
| Enum Name | Enum Value |
51+
| --------- | ---------- |
52+
| History | 0 |
53+
| Search | 1 |
54+
55+
</TabItem>
56+
57+
<TabItem value="Web">
58+
59+
### ViewType
60+
61+
| Enum Name | Enum Value |
62+
| --------- | ---------- |
63+
| History | 0 |
64+
| Search | 1 |
65+
66+
</TabItem>
67+
<TabItem value="Android">
68+
69+
### ViewType
70+
71+
| Enum Name | Enum Value |
72+
| --------- | ---------- |
73+
| History | 0 |
74+
| Search | 1 |
75+
76+
</TabItem>
77+
78+
<TabItem value="uni-app">
79+
80+
### ViewType
81+
82+
| Enum Name | Enum Value |
83+
| --------- | ---------- |
84+
| History | 0 |
85+
| Search | 1 |
86+
87+
</TabItem>
88+
89+
<TabItem value="React-Native">
90+
91+
### ViewType
92+
93+
| Enum Name | Enum Value |
94+
| --------- | ---------- |
95+
| History | 0 |
96+
| Search | 1 |
97+
98+
</TabItem>
99+
100+
<TabItem value="Unity">
101+
102+
### ViewType
103+
104+
| Enum Name | Enum Value |
105+
| --------- | ---------- |
106+
| History | 0 |
107+
| Search | 1 |
108+
109+
</TabItem>
110+
111+
</Tabs>

0 commit comments

Comments
 (0)