Skip to content

feat: update the documentation for the react native sdk v3.8.3-patch.10.2 #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bloomingg merged 6 commits into from
Nov 4, 2025
Merged

feat: update the documentation for the react native sdk v3.8.3-patch.10.2 #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b5ea4eb
feat: update React Native SDK quickstart for v3.8.3-patch.10.2
OnYourMark-1995 Nov 3, 2025
c09c60c
feat: add React Native SDK OpenIMApiError definitions
OnYourMark-1995 Nov 3, 2025
d323572
feat(rn-sdk): document OpenIMApiError; make operationID optional; upd…
OnYourMark-1995 Nov 3, 2025
d82f7db
feat(rn-sdk): add logFilePath parameter to InitConfig
OnYourMark-1995 Nov 3, 2025
b0fe6f7
feat(rn-sdk): update code examples and function prototype
OnYourMark-1995 Nov 3, 2025
182a887
feat(rn-sdk): update getAdvancedHistoryMessageList and getAdvancedHis…
OnYourMark-1995 Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/sdks/api/conversation/changeInputStates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,10 +249,10 @@ IMSDK.asyncApi('changeInputStates', IMSDK.uuid(), {
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.changeInputStates({
OpenIMSDK.changeInputStates({
conversationID: string,
focus: boolean,
}, operationID: string): Promise<void>
}, operationID?: string): Promise<void>
```

### 输入参数
Expand All @@ -261,27 +261,27 @@ OpenIMSDKRN.changeInputStates({
| -------------- | -------- | -------- | ------- |
| conversationID | string | 是 | 会话 ID |
| focus | boolean | 是 | 是否正在输入 |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果
| 参数名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------------------------- | ------------ |
| Promise.then() | Promise<void\> | 调用成功回调 |
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.changeInputStates({
OpenIMSDK.changeInputStates({
conversationID: 'conversationID',
focus: true,
}, 'operationID')
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
12 changes: 6 additions & 6 deletions docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,32 +229,32 @@ IMSDK.asyncApi(
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.clearConversationAndDeleteAllMsg(operationID: string, conversationID: string): Promise<void>
OpenIMSDK.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述 |
| -------------- | -------- | -------- | ------------------------------------------------------- |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| conversationID | string | 是 | 会话 ID |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果
| 参数名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------------------------- | ------------ |
| Promise.then() | Promise<void\> | 调用成功回调 |
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.clearConversationAndDeleteAllMsg("conversationID", 'operationID')
OpenIMSDK.clearConversationAndDeleteAllMsg("conversationID")
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
12 changes: 6 additions & 6 deletions docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,32 +223,32 @@ IMSDK.asyncApi(
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.deleteConversationAndDeleteAllMsg(operationID: string, conversationID: string): Promise<void>
OpenIMSDK.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述 |
| -------------- | -------- | -------- | ------------------------------------------------------- |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| conversationID | string | 是 | 会话 ID |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果
| 参数名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------------------------- | ------------ |
| Promise.then() | Promise<void\> | 调用成功回调 |
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.deleteConversationAndDeleteAllMsg("conversationID", 'operationID')
OpenIMSDK.deleteConversationAndDeleteAllMsg("conversationID")
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
12 changes: 6 additions & 6 deletions docs/sdks/api/conversation/getAllConversationList.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,32 +218,32 @@ IMSDK.asyncApi('getAllConversationList', IMSDK.uuid())
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.getAllConversationList(operationID: string): Promise<ConversationItem[]>
OpenIMSDK.getAllConversationList(operationID?: string): Promise<ConversationItem[]>
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述 |
| ----------- | -------- | -------- | ------------------------------------------------------- |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果

| 参数名称 | 参数类型 | 描述 |
| --------------- | --------------------------------------------------------------------------------------------- | ------------ |
| Promise.then() | Promise<[ConversationItem](docs/sdks/class/conversation/conversationInfo.mdx)[]>\> | 调用成功回调 |
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.getAllConversationList('operationID')
OpenIMSDK.getAllConversationList()
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
16 changes: 8 additions & 8 deletions docs/sdks/api/conversation/getConversationIDBySessionType.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,41 +227,41 @@ IMSDK.asyncApi('getConversationIDBySessionType', IMSDK.uuid(), {
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.getConversationIDBySessionType({
OpenIMSDK.getConversationIDBySessionType({
sourceID: string,
sessionType: number,
}, operationID: string): Promise<string>
}, operationID?: string): Promise<string>
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述 |
| ----------- | -------------------------------------------------- | -------- | ------------------------------------------------------- |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) |
| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 是 | 会话类型 |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |


### 返回结果

| 参数名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------------------------- | ------------ |
| Promise.then() | Promise<string\> | 调用成功回调 |
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.getConversationIDBySessionType({
OpenIMSDK.getConversationIDBySessionType({
sourceID: 'user1',
sessionType: 1,
}, 'operationID')
}
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
16 changes: 8 additions & 8 deletions docs/sdks/api/conversation/getConversationListSplit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,41 +245,41 @@ IMSDK.asyncApi('getConversationListSplit', IMSDK.uuid(), {
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.getConversationListSplit({
OpenIMSDK.getConversationListSplit({
offset: number,
count: number,
}, operationID: string): Promise<ConversationItem[]>
}, operationID?: string): Promise<ConversationItem[]>
```

### 输入参数

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


### 返回结果

| 参数名称 | 参数类型 | 描述 |
| --------------- | -------------------------------------------------------------------------------- | ------------ |
| Promise.then() | Promise<[ConversationItem](docs/sdks/class/conversation/conversationInfo.mdx)[]> | 调用成功回调 |
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.getConversationListSplit({
OpenIMSDK.getConversationListSplit({
offset: 0,
count: 20,
}, 'operationID')
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
16 changes: 8 additions & 8 deletions docs/sdks/api/conversation/getInputStates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,10 @@ IMSDK.asyncApi('getInputstates', IMSDK.uuid(), {
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.getInputstates({
OpenIMSDK.getInputstates({
conversationID: string,
userID: string,
}, operationID: string): Promise<number[]>
}, operationID?: string): Promise<number[]>
```

### 输入参数
Expand All @@ -259,27 +259,27 @@ OpenIMSDKRN.getInputstates({
| -------------- | -------- | -------- | ------- |
| conversationID | string | 是 | 会话 ID |
| userID | string | 是 | 用户ID |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果
| 参数名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------------------------- | ------------ |
| Promise.then() | Promise<number[]\> | 调用成功回调 |
| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.getInputstates({
OpenIMSDK.getInputstates({
conversationID: 'conversationID',
userID: 'userID',
}, 'operationID')
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
15 changes: 7 additions & 8 deletions docs/sdks/api/conversation/getMultipleConversation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,36 +218,35 @@ IMSDK.asyncApi('getMultipleConversation', IMSDK.uuid(), ['conversationID'])
### 函数原型

```ts showLineNumbers
OpenIMSDKRN.getMultipleConversation({
OpenIMSDK.getMultipleConversation({
conversationIDList: string[],
}, operationID: string): Promise<ConversationItem[]>
}, operationID?: string): Promise<ConversationItem[]>
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述 |
| ------------------ | -------- | -------- | ------------------------------------------------------- |
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
| conversationIDList | string[] | 是 | 会话 ID 列表 |

| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |

### 返回结果

| 参数名称 | 参数类型 | 描述 |
| --------------- | -------------------------------------------------------------------------------- | ------------ |
| Promise.then() | Promise<[ConversationItem](docs/sdks/class/conversation/conversationInfo.mdx)[]> | 调用成功回调 |
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 |

### 代码示例

```js showLineNumbers
import OpenIMSDKRN from "open-im-sdk-rn";
import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDKRN.getMultipleConversation(['conversationID'], 'operationID')
OpenIMSDK.getMultipleConversation(['conversationID'])
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
.catch((error) => {
// 调用失败
});
```
Expand Down
Loading