Skip to content

Commit e2a7478

Browse files
Brettstd-s
Brett
authored and
std-s
committed
chore: update docs.
1 parent ba6232c commit e2a7478

42 files changed

Lines changed: 1941 additions & 306 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/sdks/api/conversation/changeInputStates.mdx‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
sidebar_position: 16
3+
toc_min_heading_level: 2
4+
toc_max_heading_level: 2
5+
---
6+
7+
# changeInputStates
8+
9+
## 功能介绍
10+
11+
:::info 说明
12+
13+
改变输入状态
14+
15+
:::
16+
17+
:::caution 注意
18+
19+
输入结束时，需要将focus值为false
20+
21+
:::
22+
23+
<Tabs
24+
groupId="sdks-language"
25+
values={[
26+
{ label: 'iOS', value: 'iOS', },
27+
{ label: 'Android', value: 'Android', },
28+
{ label: 'Flutter', value: 'Flutter', },
29+
{ label: 'uni-app', value: 'uni-app', },
30+
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
31+
{ label: 'React-Native', value: 'React-Native', },
32+
{ label: 'Unity', value: 'Unity', },
33+
]
34+
}>
35+
36+
<TabItem value="Flutter">
37+
38+
### 函数原型
39+
40+
```dart showLineNumbers
41+
Future changeInputStates({
42+
required String conversationID,
43+
required bool focus,
44+
String? operationID,
45+
})
46+
```
47+
48+
### 输入参数
49+
50+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
51+
| -------------- | -------- | -------- | ------- |
52+
| conversationID | String | 是 | 会话 ID |
53+
| focus | bool | 是 | 是否正在输入 |
54+
55+
### 返回结果
56+
57+
| 名称 | 类型 | 描述 |
58+
| ---- | ---- | -------------------- |
59+
| ~ | ~ | 无异常抛出则操作成功 |
60+
61+
### 代码示例
62+
63+
```dart showLineNumbers
64+
await OpenIM.iMManager.conversationManager.changeInputStates(conversationID: conversationID, focus: focus);
65+
//todo
66+
```
67+
68+
</TabItem>
69+
70+
<TabItem value="iOS">
71+
72+
### 函数原型
73+
74+
```swift showLineNumbers
75+
76+
- (void)changeInputStates:(NSString *)conversationID
77+
focus:(BOOL)focus
78+
onSuccess:(nullable OIMSuccessCallback)onSuccess
79+
onFailure:(nullable OIMFailureCallback)onFailure;
80+
81+
```
82+
83+
### 输入参数
84+
85+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
86+
| -------------- | -------- | -------- | ------- |
87+
| conversationID | NSString | 是 | 会话 ID |
88+
| focus | BOOL | 是 | 是否正在输入 |
89+
90+
### 返回结果
91+
92+
| 名称 | 类型 | 描述 |
93+
| --------- | ------------------------------------------------------ | -------- |
94+
| onSuccess | OIMSuccessCallback | 成功返回 |
95+
| onFailure | OIMFailureCallback | 失败返回 |
96+
97+
### 代码示例
98+
99+
```swift showLineNumbers
100+
101+
[OIMManager.manager changeInputStates:@""
102+
focus:
103+
onSuccess:^(NSString * _Nullable data) {
104+
105+
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
106+
107+
}];
108+
109+
```
110+
111+
</TabItem>
112+
113+
<TabItem value="Android">
114+
115+
</TabItem>
116+
117+
<TabItem value="Web">
118+
119+
</TabItem>
120+
121+
<TabItem value="uni-app">
122+
123+
</TabItem>
124+
125+
<TabItem value="React-Native">
126+
127+
</TabItem>
128+
129+
<TabItem value="Unity">
130+
131+
</TabItem>
132+
133+
</Tabs>

‎docs/sdks/api/conversation/getInputStates.mdx‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
sidebar_position: 17
3+
toc_min_heading_level: 2
4+
toc_max_heading_level: 2
5+
---
6+
7+
# getInputStates
8+
9+
## 功能介绍
10+
11+
:::info 说明
12+
13+
获取某用户当前输入状态。
14+
15+
:::
16+
17+
<Tabs
18+
groupId="sdks-language"
19+
values={[
20+
{ label: 'iOS', value: 'iOS', },
21+
{ label: 'Android', value: 'Android', },
22+
{ label: 'Flutter', value: 'Flutter', },
23+
{ label: 'uni-app', value: 'uni-app', },
24+
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
25+
{ label: 'React-Native', value: 'React-Native', },
26+
{ label: 'Unity', value: 'Unity', },
27+
]
28+
}>
29+
30+
31+
<TabItem value="Flutter">
32+
33+
### 函数原型
34+
35+
```dart showLineNumbers
36+
Future getInputstates({
37+
required String conversationID,
38+
required String userID,
39+
String? operationID,
40+
})
41+
```
42+
43+
### 输入参数
44+
45+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
46+
| -------------- | -------- | -------- | ------- |
47+
| conversationID | String | 是 | 会话 ID |
48+
| userID | String | 是 | 用户ID |
49+
50+
### 返回结果
51+
52+
| 名称 | 类型 | 描述 |
53+
| ---- | ---- | -------------------- |
54+
| ~ | ~ | 无异常抛出则操作成功 |
55+
56+
### 代码示例
57+
58+
```dart showLineNumbers
59+
await OpenIM.iMManager.conversationManager.getInputstates(conversationID: conversationID, userID: );
60+
//todo
61+
```
62+
63+
</TabItem>
64+
65+
<TabItem value="iOS">
66+
67+
### 函数原型
68+
69+
```swift showLineNumbers
70+
71+
- (void)getInputstates:(NSString *)conversationID
72+
userID:(NSString)userID
73+
onSuccess:(nullable OIMSuccessCallback)onSuccess
74+
onFailure:(nullable OIMFailureCallback)onFailure;
75+
76+
```
77+
78+
### 输入参数
79+
80+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
81+
| -------------- | -------- | -------- | ------- |
82+
| conversationID | NSString | 是 | 会话 ID |
83+
| userID | NSString | 是 | 用户ID |
84+
85+
### 返回结果
86+
87+
| 名称 | 类型 | 描述 |
88+
| --------- | ------------------------------------------------------ | -------- |
89+
| onSuccess | OIMSuccessCallback | 成功返回 |
90+
| onFailure | OIMFailureCallback | 失败返回 |
91+
92+
### 代码示例
93+
94+
```swift showLineNumbers
95+
96+
[OIMManager.manager getInputstates:@""
97+
userID:
98+
onSuccess:^(NSString * _Nullable data) {
99+
100+
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
101+
102+
}];
103+
104+
```
105+
106+
</TabItem>
107+
108+
<TabItem value="Android">
109+
110+
111+
</TabItem>
112+
113+
<TabItem value="Web">
114+
115+
116+
</TabItem>
117+
118+
<TabItem value="uni-app">
119+
120+
121+
</TabItem>
122+
<TabItem value="React-Native">
123+
124+
</TabItem>
125+
126+
<TabItem value="Unity">
127+
128+
</TabItem>
129+
130+
</Tabs>

‎docs/sdks/api/conversation/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ toc_max_heading_level: 2
3030
| [deleteConversationAndDeleteAllMsg](docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx) | 删除会话及会话中消息 |
3131
| [clearConversationAndDeleteAllMsg](docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx) | 删除会话中的消息 |
3232
| [setConversation](docs/sdks/api/conversation/setConversation.mdx) | 设置会话信息 |
33+
| [changeInputStates](docs/sdks/api/conversation/changeInputStates.mdx) | 改变输入状态 |
34+
| [getInputStates](docs/sdks/api/conversation/getInputStates.mdx) | 获取输入状态 |

‎docs/sdks/api/group/getJoinedGroupListPage.mdx‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ toc_max_heading_level: 2
77
# getJoinedGroupListPage
88

99

10-
# TODO！Need Update. Only write info and title.
11-
1210
## 功能介绍
1311

1412
:::info 说明
@@ -41,23 +39,26 @@ values={[
4139
### 函数原型
4240

4341
```dart showLineNumbers
44-
Future<List<GroupInfo>> getJoinedGroupList({String? operationID})
42+
Future<List<GroupInfo>> getJoinedGroupListPage({String? operationID, int offset = 0, int count = 40});
4543
```
4644

4745
### 输入参数
4846

49-
无
47+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
48+
| -------- | -------- | -------- | ------- |
49+
| offset | int | 是 | 分页拉取起始下标 |
50+
| count | int | 是 | 一页拉取的数量 |
5051

5152
### 返回结果
5253

5354
| 参数名称 | 参数类型 | 描述 |
5455
| -------- | ------------------------------------------------------ | -------- |
55-
| ~ | List<[GroupInfo](docs/sdks/class/group/groupInfo.mdx)> | 成功返回 |
56+
| ~ | List< [GroupInfo](docs/sdks/class/group/groupInfo.mdx)> | 成功返回 |
5657

5758
### 代码示例
5859

5960
```dart showLineNumbers
60-
List<GroupInfo> list = await OpenIM.iMManager.groupManager.getJoinedGroupList();
61+
List<GroupInfo> list = await OpenIM.iMManager.groupManager.getJoinedGroupListPage();
6162
// todo
6263
```
6364

@@ -69,14 +70,19 @@ values={[
6970

7071
```swift showLineNumbers
7172

72-
- (void)getJoinedGroupListWithOnSuccess:(nullable OIMGroupsInfoCallback)onSuccess
73+
- (void)getJoinedGroupListPageWithOffset:(NSInteger)offset
74+
count:(NSInteger)count
75+
onSuccess:(nullable OIMGroupsInfoCallback)onSuccess
7376
onFailure:(nullable OIMFailureCallback)onFailure;
7477

7578
```
7679

7780
### 输入参数
7881

79-
无
82+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
83+
| -------- | -------- | -------- | ------- |
84+
| offset | int | 是 | 分页拉取起始下标 |
85+
| count | int | 是 | 一页拉取的数量 |
8086

8187
### 返回结果
8288

@@ -89,7 +95,9 @@ values={[
8995

9096
```swift showLineNumbers
9197

92-
[OIMManager.manager getJoinedGroupListWithOnSuccess:^(NSArray<OIMGroupInfo *> * _Nullable groupsInfo) {
98+
[OIMManager.manager getJoinedGroupListWithOffset:
99+
count:
100+
onSuccess:^(NSArray<OIMGroupInfo *> * _Nullable groupsInfo) {
93101
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
94102
}];
95103

0 commit comments

Comments
 (0)