Skip to content

Commit 4b0b405

Browse files
lgz5689lgz5689
authored
docs: update api doc (#200)
1 parent 2ad595e commit 4b0b405

18 files changed

Lines changed: 1318 additions & 223 deletions

File tree

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

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,145 @@ Future changeInputStates({
116116

117117
<TabItem value="Web">
118118

119+
### 函数原型
120+
121+
```ts showLineNumbers
122+
IMSDK.changeInputStates({
123+
conversationID: string,
124+
focus: boolean,
125+
}, operationID?: string): Promise<WsResponse>
126+
```
127+
128+
### 输入参数
129+
130+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
131+
| -------------- | -------- | -------- | ------- |
132+
| conversationID | string | 是 | 会话 ID |
133+
| focus | boolean | 是 | 是否正在输入 |
134+
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
135+
136+
### 返回结果
137+
138+
| 参数名称 | 参数类型 | 描述 |
139+
| --------------- | ---------------------------------------------------- | ------------ |
140+
| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 |
141+
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
142+
143+
### 代码示例
144+
145+
```js showLineNumbers
146+
import { getSDK } from '@openim/wasm-client-sdk';
147+
const IMSDK = getSDK();
148+
149+
// use in electron with ffi
150+
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
151+
// const { instance: IMSDK } = getWithRenderProcess();
152+
153+
// use in mini program
154+
// import { OpenIMSDK } from 'open-im-sdk';
155+
// const IMSDK = new OpenIMSDK();
156+
157+
IMSDK.changeInputStates({
158+
conversationID: 'conversationID',
159+
focus: true,
160+
})
161+
.then(() => {
162+
// 调用成功
163+
})
164+
.catch(({ errCode, errMsg }) => {
165+
// 调用失败
166+
});
167+
```
168+
119169
</TabItem>
120170

121171
<TabItem value="uni-app">
122172

173+
### 函数原型
174+
175+
```ts showLineNumbers
176+
IMSDK.asyncApi('changeInputStates', operationID: string, {
177+
conversationID: string,
178+
focus: boolean,
179+
}): Promise<void>
180+
```
181+
182+
### 输入参数
183+
184+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
185+
| -------------- | -------- | -------- | ------- |
186+
| conversationID | string | 是 | 会话 ID |
187+
| focus | boolean | 是 | 是否正在输入 |
188+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
189+
190+
### 返回结果
191+
192+
> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。
193+
194+
| 参数名称 | 参数类型 | 描述 |
195+
| --------------- | ------------------------------------------------------- | ------------ |
196+
| Promise.then() | Promise<void\> | 调用成功回调 |
197+
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
198+
199+
### 代码示例
200+
201+
```js showLineNumbers
202+
import IMSDK from 'openim-uniapp-polyfill';
203+
204+
IMSDK.asyncApi('changeInputStates', IMSDK.uuid(), {
205+
conversationID: 'conversationID',
206+
focus: true,
207+
})
208+
.then(() => {
209+
// 调用成功
210+
})
211+
.catch(({ errCode, errMsg }) => {
212+
// 调用失败
213+
});
214+
```
215+
123216
</TabItem>
124217

125218
<TabItem value="React-Native">
219+
### 函数原型
220+
221+
```ts showLineNumbers
222+
OpenIMSDKRN.changeInputStates({
223+
conversationID: string,
224+
focus: boolean,
225+
}, operationID: string): Promise<void>
226+
```
227+
228+
### 输入参数
229+
230+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
231+
| -------------- | -------- | -------- | ------- |
232+
| conversationID | string | 是 | 会话 ID |
233+
| focus | boolean | 是 | 是否正在输入 |
234+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
235+
236+
### 返回结果
237+
| 参数名称 | 参数类型 | 描述 |
238+
| --------------- | ------------------------------------------------------- | ------------ |
239+
| Promise.then() | Promise<void\> | 调用成功回调 |
240+
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
241+
242+
### 代码示例
243+
244+
```js showLineNumbers
245+
import OpenIMSDKRN from "open-im-sdk-rn";
246+
247+
OpenIMSDKRN.changeInputStates({
248+
conversationID: 'conversationID',
249+
focus: true,
250+
}, 'operationID')
251+
.then(() => {
252+
// 调用成功
253+
})
254+
.catch(({ errCode, errMsg }) => {
255+
// 调用失败
256+
});
257+
```
126258

127259
</TabItem>
128260

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

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,149 @@ Future getInputstates({
112112

113113
<TabItem value="Web">
114114

115+
### 函数原型
116+
117+
```ts showLineNumbers
118+
IMSDK.getInputstates({
119+
conversationID: string,
120+
userID: string,
121+
}, operationID?: string): Promise<WsResponse<number[]>>
122+
```
123+
124+
### 输入参数
125+
126+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
127+
| -------------- | -------- | -------- | ------- |
128+
| conversationID | string | 是 | 会话 ID |
129+
| userID | string | 是 | 用户ID |
130+
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
131+
132+
### 返回结果
133+
134+
| 参数名称 | 参数类型 | 描述 |
135+
| --------------- | ---------------------------------------------------- | ------------ |
136+
| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)<number[]>\> | 调用成功回调 |
137+
| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
138+
139+
### 代码示例
140+
141+
```js showLineNumbers
142+
import { getSDK } from '@openim/wasm-client-sdk';
143+
const IMSDK = getSDK();
144+
145+
// use in electron with ffi
146+
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
147+
// const { instance: IMSDK } = getWithRenderProcess();
148+
149+
// use in mini program
150+
// import { OpenIMSDK } from 'open-im-sdk';
151+
// const IMSDK = new OpenIMSDK();
152+
153+
IMSDK.getInputstates({
154+
conversationID: 'conversationID',
155+
userID: 'userID',
156+
})
157+
.then(() => {
158+
// 调用成功
159+
})
160+
.catch(({ errCode, errMsg }) => {
161+
// 调用失败
162+
});
163+
```
164+
115165

116166
</TabItem>
117167

118168
<TabItem value="uni-app">
119169

170+
### 函数原型
171+
172+
```ts showLineNumbers
173+
IMSDK.asyncApi('getInputstates', operationID: string, {
174+
conversationID: string,
175+
userID: string,
176+
}): Promise<number[]>
177+
```
178+
179+
### 输入参数
180+
181+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
182+
| -------------- | -------- | -------- | ------- |
183+
| conversationID | string | 是 | 会话 ID |
184+
| userID | string | 是 | 用户ID |
185+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
186+
187+
### 返回结果
188+
189+
> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。
190+
191+
| 参数名称 | 参数类型 | 描述 |
192+
| --------------- | ------------------------------------------------------- | ------------ |
193+
| Promise.then() | Promise<number[]\> | 调用成功回调 |
194+
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
195+
196+
### 代码示例
197+
198+
```js showLineNumbers
199+
import IMSDK from 'openim-uniapp-polyfill';
200+
201+
IMSDK.asyncApi('getInputstates', IMSDK.uuid(), {
202+
conversationID: 'conversationID',
203+
userID: 'userID',
204+
})
205+
.then(() => {
206+
// 调用成功
207+
})
208+
.catch(({ errCode, errMsg }) => {
209+
// 调用失败
210+
});
211+
```
212+
120213

121214
</TabItem>
122215
<TabItem value="React-Native">
123216

217+
### 函数原型
218+
219+
```ts showLineNumbers
220+
OpenIMSDKRN.getInputstates({
221+
conversationID: string,
222+
userID: string,
223+
}, operationID: string): Promise<number[]>
224+
```
225+
226+
### 输入参数
227+
228+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
229+
| -------------- | -------- | -------- | ------- |
230+
| conversationID | string | 是 | 会话 ID |
231+
| userID | string | 是 | 用户ID |
232+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
233+
234+
### 返回结果
235+
| 参数名称 | 参数类型 | 描述 |
236+
| --------------- | ------------------------------------------------------- | ------------ |
237+
| Promise.then() | Promise<number[]\> | 调用成功回调 |
238+
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
239+
240+
### 代码示例
241+
242+
```js showLineNumbers
243+
import OpenIMSDKRN from "open-im-sdk-rn";
244+
245+
OpenIMSDKRN.getInputstates({
246+
conversationID: 'conversationID',
247+
userID: 'userID',
248+
}, 'operationID')
249+
.then(() => {
250+
// 调用成功
251+
})
252+
.catch(({ errCode, errMsg }) => {
253+
// 调用失败
254+
});
255+
```
256+
257+
124258
</TabItem>
125259

126260
<TabItem value="Unity">

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

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,19 @@ OpenIMClient.getInstance().groupManager.getJoinedGroupList(new OnBase<List<Group
149149
### 函数原型
150150

151151
```ts showLineNumbers
152-
IMSDK.getJoinedGroupList(operationID?: string): Promise<WsResponse<GroupItem[]>>
152+
IMSDK.getJoinedGroupList({
153+
offset: number;
154+
count: number;
155+
}, operationID?: string): Promise<WsResponse<GroupItem[]>>
153156
```
154157

155158
### 输入参数
156159

157-
无
160+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
161+
| -------- | -------- | -------- | ------- |
162+
| offset | number | 是 | 分页拉取起始下标 |
163+
| count | number | 是 | 一页拉取的数量 |
164+
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
158165

159166
### 返回结果
160167

@@ -177,7 +184,7 @@ const IMSDK = getSDK();
177184
// import { OpenIMSDK } from 'open-im-sdk';
178185
// const IMSDK = new OpenIMSDK();
179186

180-
IMSDK.getJoinedGroupList()
187+
IMSDK.getJoinedGroupList({ offset: 0, count: 1000 })
181188
.then(({ data }) => {
182189
// 调用成功
183190
})
@@ -193,15 +200,19 @@ IMSDK.getJoinedGroupList()
193200
### 函数原型
194201

195202
```ts showLineNumbers
196-
IMSDK.asyncApi('getJoinedGroupList', operationID: string): Promise<GroupItem[]>
203+
IMSDK.asyncApi('getJoinedGroupList', operationID: string, {
204+
offset: number;
205+
count: number;
206+
}): Promise<GroupItem[]>
197207
```
198208

199209
### 输入参数
200210

201-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
202-
| ----------- | -------- | -------- | ------------------------------------------------------- |
203-
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
204-
211+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
212+
| -------- | -------- | -------- | ------- |
213+
| offset | number | 是 | 分页拉取起始下标 |
214+
| count | number | 是 | 一页拉取的数量 |
215+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
205216
### 返回结果
206217

207218
> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。
@@ -216,7 +227,7 @@ IMSDK.asyncApi('getJoinedGroupList', operationID: string): Promise<GroupItem[]>
216227
```js showLineNumbers
217228
import IMSDK from 'openim-uniapp-polyfill';
218229

219-
IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid())
230+
IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid(), { offset: 0, count: 1000 })
220231
.then((data) => {
221232
// 调用成功
222233
})
@@ -231,14 +242,19 @@ IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid())
231242
### 函数原型
232243

233244
```ts showLineNumbers
234-
OpenIMSDKRN.getJoinedGroupList(operationID: string): Promise<GroupItem[]>
245+
OpenIMSDKRN.getJoinedGroupList({
246+
offset: number;
247+
count: number;
248+
}, operationID: string): Promise<GroupItem[]>
235249
```
236250

237251
### 输入参数
238252

239-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
240-
| ----------- | -------- | -------- | ------------------------------------------------------- |
241-
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
253+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
254+
| -------- | -------- | -------- | ------- |
255+
| offset | number | 是 | 分页拉取起始下标 |
256+
| count | number | 是 | 一页拉取的数量 |
257+
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
242258

243259
### 返回结果
244260

@@ -252,7 +268,10 @@ OpenIMSDKRN.getJoinedGroupList(operationID: string): Promise<GroupItem[]>
252268
```js showLineNumbers
253269
import OpenIMSDKRN from "open-im-sdk-rn";
254270

255-
OpenIMSDKRN.getJoinedGroupList('operationID')
271+
OpenIMSDKRN.getJoinedGroupList({
272+
offset: 0;
273+
count: 1000;
274+
}, 'operationID')
256275
.then((data) => {
257276
// 调用成功
258277
})

0 commit comments

Comments
 (0)