Skip to content

Commit b4cc979

Browse files
JauneQJauneQ
authored
Merge branch 'openimsdk:main' into main
2 parents 77366bd + a4e9faa commit b4cc979

23 files changed

Lines changed: 1332 additions & 238 deletions

File tree

‎docs/restapi/apis/conversationManagement/getOwnerConversation.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ hide_title: true
66

77
<center>
88

9-
## 获取当前用户的分页会话列表
9+
## 获取当前用户的会话列表
1010

1111
</center>
1212

1313
### 简要描述
14-
- 获取当前用户的分页会话列表
14+
- 获取当前用户的会话列表
1515
### 请求方式
1616
- `post`
1717
### 请求URL

‎docs/restapi/apis/conversationManagement/setConversations.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
sidebar_position: 3
3-
title: 多个用户对同一会话设置字段
3+
title: 多个用户对同一ID的会话设置字段
44
hide_title: true
55
---
66

77
<center>
88

9-
## 多个用户对同一会话设置字段
9+
## 多个用户对同一ID的会话设置字段
1010

1111
</center>
1212

‎docs/restapi/apis/groupManagement/setGroupInfo.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ hide_title: true
4545
```
4646
|字段名|选填|类型|说明|
4747
|:---- |:------- |:--- |---|
48-
|groupInfoForSet|必填|object|群信息对象|
4948
|groupID|必填|string|要修改的群ID|
5049
|groupName|选填|string|新群名|
5150
|notification|选填|string|新群公告|

‎docs/restapi/apis/userManagement/getSubscribeUsersStatus.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ hide_title: true
7070
| data | object | 通用数据对象，具体结构见下方 |
7171
| statusList | array | 订阅用户在线状态列表 |
7272
| statusList.userID | string | 用户 ID |
73-
| statusList.status | int | 在线状态，0 ：offline，1：online |
73+
| statusList.status | int | 在线状态，0：offline，1：online |
7474
| statusList.platformIDs | array | [用户登录时的终端类型](docs/restapi/commonFields.mdx)列表，可存在多端在线。取值为1-9 |
7575

7676
### 失败返回示例

‎docs/restapi/apis/userManagement/subscribeUsersStatus.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ hide_title: true
8484
| data | object | 通用数据对象，具体结构见下方 |
8585
| statusList | array | 状态返回结果 |
8686
| statusList.userID | string | 用户账号 |
87-
| statusList.status | int | 在线状态，0 ：offline，1：online |
87+
| statusList.status | int | 在线状态，0：offline，1：online |
8888
| statusList.platformIDs | array | [用户登录时的终端类型](docs/restapi/commonFields.mdx)列表，可能多端在线，取值为1-9 |
8989

9090
### 失败返回示例

‎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: 138 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Future getInputstates({
5151

5252
| 名称 | 类型 | 描述 |
5353
| ---- | ---- | -------------------- |
54-
| ~ | ~ | 无异常抛出则操作成功 |
54+
| ~ | Future< List< int>?> | 无异常抛出则操作成功 |
5555

5656
### 代码示例
5757

@@ -70,7 +70,7 @@ Future getInputstates({
7070

7171
- (void)getInputstates:(NSString *)conversationID
7272
userID:(NSString)userID
73-
onSuccess:(nullable OIMSuccessCallback)onSuccess
73+
onSuccess:(nullable OIMInputStatusChangedCallback)onSuccess
7474
onFailure:(nullable OIMFailureCallback)onFailure;
7575

7676
```
@@ -86,7 +86,7 @@ Future getInputstates({
8686

8787
| 名称 | 类型 | 描述 |
8888
| --------- | ------------------------------------------------------ | -------- |
89-
| onSuccess | OIMSuccessCallback | 成功返回 |
89+
| onSuccess | NSArray< NSNumber \*> | 成功返回 |
9090
| onFailure | OIMFailureCallback | 失败返回 |
9191

9292
### 代码示例
@@ -95,7 +95,7 @@ Future getInputstates({
9595

9696
[OIMManager.manager getInputstates:@""
9797
userID:
98-
onSuccess:^(NSString * _Nullable data) {
98+
onSuccess:^(NSArray<NSNumber *> * _Nullable data) {
9999

100100
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
101101

@@ -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">

0 commit comments

Comments
 (0)