From b5ea4eb04f8a768fb7807ebd2679f8e47ad52917 Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 16:23:42 +0800 Subject: [PATCH 1/6] feat: update React Native SDK quickstart for v3.8.3-patch.10.2 --- docs/sdks/quickstart/reactNative.mdx | 77 +++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 12 deletions(-) diff --git a/docs/sdks/quickstart/reactNative.mdx b/docs/sdks/quickstart/reactNative.mdx index 78208d9558..b42b152ff3 100644 --- a/docs/sdks/quickstart/reactNative.mdx +++ b/docs/sdks/quickstart/reactNative.mdx @@ -9,40 +9,68 @@ sidebar_position: 4 ## 注意事项 ❗️ -- `open-im-sdk-rn@3.5.1` 包含了重大的破坏性更新。如果您需要升级，请检查传入参数和返回数据。 +- 从 `v3.8.3-patch.10` 版本开始，包名从 `open-im-sdk-rn` 改为 `@openim/rn-client-sdk`。 -- 与其他SDK不同，`React Native SDK` **operationID** 不是可选的，而是必填的。（operationID 用于后端日志查询） +- 从 `v3.8.3-patch.10.2` 版本开始，`operationID` 参数是可选的（如果未提供，SDK 将自动生成一个），在之前的版本，这个参数是必填的，必须显式传递。（operationID 用于后端日志查询） + +- 从 `v3.8.3-patch.10.2` 版本开始，您可以使用 `OpenIMSDK.on()` 来监听事件，在之前的版本，您必须使用 `OpenIMEmitter` 对象。最新版本兼容两种方式，但推荐使用 `OpenIMSDK.on()`，因为它提供了更好的 TypeScript 类型提示。 + +- `v3.5.1` 包含了重大的破坏性更新。如果您需要升级，请检查传入参数和返回数据。 ## 集成步骤 ( React Native CLI ) ### 1. 添加依赖 ```sh -yarn add open-im-sdk-rn +yarn add @openim/rn-client-sdk ``` ### 2. 初始化 SDK ```ts -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; import RNFS from 'react-native-fs'; RNFS.mkdir(RNFS.DocumentDirectoryPath + '/tmp'); -OpenIMSDKRN.initSDK({ +OpenIMSDK.initSDK({ platformID: 2, // 1: ios, 2: android apiAddr: 'http://your-server-ip:10002', wsAddr: 'ws://your-server-ip:10001', dataDir: RNFS.DocumentDirectoryPath + '/tmp', + logFilePath: RNFS.DocumentDirectoryPath + '/tmp', logLevel: 5, isLogStandardOutput: true, -}, 'opid'); +}); ``` ### 3. 登录、设置监听 ```ts -import OpenIMSDKRN, { OpenIMEmitter } from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; + +OpenIMSDK.login({ + userID: 'IM user ID', + token: 'IM user token', +}); + +OpenIMSDK.on('onConnecting', () => { + console.log('onConnecting'); +}); + +OpenIMSDK.on('onConnectSuccess', () => { + console.log('onConnectSuccess'); +}); + +OpenIMSDK.on('onConnectFailed', ({ errCode, errMsg }) => { + console.log('onConnectFailed', errCode, errMsg); +}); +``` + +如果您使用的是 `v3.8.3-patch.10.2` 以前的版本，请使用以下代码： + +```ts +import OpenIMSDKRN, { OpenIMEmitter } from '@openim/rn-client-sdk'; OpenIMSDKRN.login({ userID: 'IM user ID', @@ -65,11 +93,36 @@ OpenIMEmitter.addListener('onConnectFailed', ({ errCode, errMsg }) => { ### 4. 收发消息 ```ts -import OpenIMSDKRN, { OpenIMEmitter } from 'open-im-sdk-rn'; -import type { MessageItem } from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; +import type { MessageItem } from '@openim/rn-client-sdk'; + +OpenIMSDK.on('onRecvNewMessages', (messages: MessageItem[]) => { + console.log('onRecvNewMessages', messages); +}); + +const message = await OpenIMSDK.createTextMessage('hello openim'); + +OpenIMSDK.sendMessage({ + recvID: 'recipient user ID', + groupID: '', + message, +}) + .then(() => { + // Message sent successfully ✉️ + }) + .catch(err => { + // Failed to send message ❌ + console.log(err); + }); +``` + +如果您使用的是 `v3.8.3-patch.10.2` 以前的版本，请使用以下代码： + +```ts +import OpenIMSDKRN, { OpenIMEmitter } from '@openim/rn-client-sdk'; -OpenIMEmitter.addListener('onRecvNewMessages', (data: MessageItem[]) => { - console.log('onRecvNewMessages', data); +OpenIMEmitter.addListener('onRecvNewMessages', (messages) => { + console.log('onRecvNewMessages', messages); }); const message = await OpenIMSDKRN.createTextMessage('hello openim', 'opid'); @@ -86,4 +139,4 @@ OpenIMSDKRN.sendMessage({ // Failed to send message ❌ console.log(err); }); -``` \ No newline at end of file +``` From c09c60c4173b4b419ec83cb0584fd13d523f5ccc Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 16:33:08 +0800 Subject: [PATCH 2/6] feat: add React Native SDK OpenIMApiError definitions --- docs/sdks/class/response.mdx | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/sdks/class/response.mdx b/docs/sdks/class/response.mdx index b650b477c1..6944fd018a 100644 --- a/docs/sdks/class/response.mdx +++ b/docs/sdks/class/response.mdx @@ -46,23 +46,34 @@ type CatchResponse = { -### CatchResponse +### OpenIMApiError ### 类型 ```ts -type CatchResponse = { - errCode: number; - errMsg: string; -}; +export class OpenIMApiError extends Error { + name: string = 'OpenIMApiError'; + code: number; + message: string; + operationID: string; + + constructor(code: number, message: string, operationID: string) { + super(message); + this.code = code; + this.message = message; + this.operationID = operationID; + } +} ``` ### 字段说明 | 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ------------------------ | --- | -| errCode | number | 调用失败时的错误码 | -| errMsg | string | 调用失败时的错误描述信息 | | +| -------- | -------- | ------------------------ | +| name | string | 错误名称 | +| code | number | 调用失败时的错误码 | +| message | string | 调用失败时的错误描述信息 | | +| operationID | string | 调用时传入的 operationID | From d323572afb8d94b4e40bf06a53469e08994f8014 Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 17:26:02 +0800 Subject: [PATCH 3/6] feat(rn-sdk): document OpenIMApiError; make operationID optional; update API params - Replace CatchResponse with OpenIMApiError (name, code, message, operationID) - Mark operationID as optional across RN SDK docs - Update params for getFriendApplicationListAsApplicant/Recipient and getGroupApplicationListAsApplicant/Recipient --- docs/sdks/api/conversation/changeInputStates.mdx | 6 +++--- .../clearConversationAndDeleteAllMsg.mdx | 6 +++--- .../deleteConversationAndDeleteAllMsg.mdx | 6 +++--- .../api/conversation/getAllConversationList.mdx | 6 +++--- .../getConversationIDBySessionType.mdx | 6 +++--- .../api/conversation/getConversationListSplit.mdx | 6 +++--- docs/sdks/api/conversation/getInputStates.mdx | 6 +++--- .../api/conversation/getMultipleConversation.mdx | 7 +++---- docs/sdks/api/conversation/getOneConversation.mdx | 7 +++---- .../api/conversation/getTotalUnreadMsgCount.mdx | 6 +++--- .../sdks/api/conversation/hideAllConversation.mdx | 4 ++-- docs/sdks/api/conversation/hideConversation.mdx | 8 ++++---- .../markConversationMessageAsRead.mdx | 6 +++--- docs/sdks/api/conversation/setConversation.mdx | 4 ++-- .../api/conversation/setConversationDraft.mdx | 6 +++--- docs/sdks/api/group/acceptGroupApplication.mdx | 6 +++--- docs/sdks/api/group/changeGroupMemberMute.mdx | 6 +++--- docs/sdks/api/group/changeGroupMute.mdx | 6 +++--- docs/sdks/api/group/createGroup.mdx | 6 +++--- docs/sdks/api/group/dismissGroup.mdx | 6 +++--- .../group/getGroupApplicationListAsApplicant.mdx | 15 ++++++++++++--- .../group/getGroupApplicationListAsRecipient.mdx | 15 ++++++++++++--- docs/sdks/api/group/getGroupMemberList.mdx | 6 +++--- .../group/getGroupMemberListByJoinTimeFilter.mdx | 6 +++--- .../api/group/getGroupMemberOwnerAndAdmin.mdx | 6 +++--- docs/sdks/api/group/getJoinedGroupList.mdx | 6 +++--- docs/sdks/api/group/getJoinedGroupListPage.mdx | 6 +++--- .../api/group/getSpecifiedGroupMembersInfo.mdx | 6 +++--- docs/sdks/api/group/getSpecifiedGroupsInfo.mdx | 6 +++--- docs/sdks/api/group/getUsersInGroup.mdx | 6 +++--- docs/sdks/api/group/inviteUserToGroup.mdx | 6 +++--- docs/sdks/api/group/isJoinGroup.mdx | 6 +++--- docs/sdks/api/group/joinGroup.mdx | 6 +++--- docs/sdks/api/group/kickGroupMember.mdx | 6 +++--- docs/sdks/api/group/quitGroup.mdx | 7 +++---- docs/sdks/api/group/refuseGroupApplication.mdx | 6 +++--- docs/sdks/api/group/searchGroupMembers.mdx | 6 +++--- docs/sdks/api/group/searchGroups.mdx | 6 +++--- docs/sdks/api/group/setGroupInfo.mdx | 6 +++--- docs/sdks/api/group/setGroupMemberInfo.mdx | 6 +++--- docs/sdks/api/group/transferGroupOwner.mdx | 6 +++--- docs/sdks/api/initialization/getLoginStatus.mdx | 10 +++++----- docs/sdks/api/initialization/getLoginUserID.mdx | 4 ++-- docs/sdks/api/initialization/initSDK.mdx | 14 +++++++------- docs/sdks/api/initialization/login.mdx | 6 +++--- docs/sdks/api/initialization/logout.mdx | 6 +++--- docs/sdks/api/initialization/unInitSDK.mdx | 6 +++--- docs/sdks/api/message/createCardMessage.mdx | 6 +++--- docs/sdks/api/message/createCustomMessage.mdx | 6 +++--- docs/sdks/api/message/createFaceMessage.mdx | 6 +++--- docs/sdks/api/message/createFileMessageByURL.mdx | 6 +++--- .../api/message/createFileMessageFromFullPath.mdx | 6 +++--- docs/sdks/api/message/createForwardMessage.mdx | 6 +++--- docs/sdks/api/message/createImageMessageByURL.mdx | 7 ++++--- .../message/createImageMessageFromFullPath.mdx | 6 +++--- docs/sdks/api/message/createLocationMessage.mdx | 6 +++--- docs/sdks/api/message/createMergeMessage.mdx | 6 +++--- docs/sdks/api/message/createQuoteMessage.mdx | 6 +++--- docs/sdks/api/message/createSoundMessageByURL.mdx | 6 +++--- .../message/createSoundMessageFromFullPath.mdx | 6 +++--- docs/sdks/api/message/createTextAtMessage.mdx | 6 +++--- docs/sdks/api/message/createTextMessage.mdx | 6 +++--- docs/sdks/api/message/createVideoMessageByURL.mdx | 6 +++--- .../message/createVideoMessageFromFullPath.mdx | 6 +++--- docs/sdks/api/message/deleteAllMsgFromLocal.mdx | 6 +++--- .../api/message/deleteAllMsgFromLocalAndSvr.mdx | 6 +++--- docs/sdks/api/message/deleteMessage.mdx | 6 +++--- .../api/message/deleteMessageFromLocalStorage.mdx | 6 +++--- docs/sdks/api/message/findMessageList.mdx | 6 +++--- .../api/message/getAdvancedHistoryMessageList.mdx | 6 +++--- .../getAdvancedHistoryMessageListReverse.mdx | 6 +++--- .../message/insertGroupMessageToLocalStorage.mdx | 6 +++--- .../message/insertSingleMessageToLocalStorage.mdx | 6 +++--- docs/sdks/api/message/revokeMessage.mdx | 6 +++--- docs/sdks/api/message/searchLocalMessages.mdx | 6 +++--- docs/sdks/api/message/sendMessage.mdx | 6 +++--- docs/sdks/api/message/sendMessageNotOss.mdx | 6 +++--- docs/sdks/api/message/setMessageLocalEx.mdx | 6 +++--- docs/sdks/api/message/typingStatusUpdate.mdx | 6 +++--- .../sdks/api/relation/acceptFriendApplication.mdx | 6 +++--- docs/sdks/api/relation/addBlack.mdx | 6 +++--- docs/sdks/api/relation/addFriend.mdx | 4 ++-- docs/sdks/api/relation/checkFriend.mdx | 6 +++--- docs/sdks/api/relation/deleteFriend.mdx | 6 +++--- docs/sdks/api/relation/getBlackList.mdx | 6 +++--- .../getFriendApplicationListAsApplicant.mdx | 11 ++++++++--- .../getFriendApplicationListAsRecipient.mdx | 13 ++++++++++--- docs/sdks/api/relation/getFriendList.mdx | 8 ++++---- docs/sdks/api/relation/getFriendListPage.mdx | 6 +++--- .../sdks/api/relation/getSpecifiedFriendsInfo.mdx | 6 +++--- .../sdks/api/relation/refuseFriendApplication.mdx | 6 +++--- docs/sdks/api/relation/removeBlack.mdx | 6 +++--- docs/sdks/api/relation/searchFriends.mdx | 6 +++--- docs/sdks/api/relation/updateFriends.mdx | 6 +++--- docs/sdks/api/third/logs.mdx | 6 +++--- docs/sdks/api/third/setAppBadge.mdx | 6 +++--- docs/sdks/api/third/updateFcmToken.mdx | 9 ++++----- docs/sdks/api/third/uploadFile.mdx | 6 +++--- docs/sdks/api/third/uploadLogs.mdx | 6 +++--- docs/sdks/api/user/getSelfUserInfo.mdx | 7 +++---- docs/sdks/api/user/getSubscribeUsersStatus.mdx | 6 +++--- docs/sdks/api/user/getUsersInfo.mdx | 6 +++--- docs/sdks/api/user/setSelfInfo.mdx | 10 +++++----- docs/sdks/api/user/subscribeUsersStatus.mdx | 6 +++--- docs/sdks/api/user/unsubscribeUsersStatus.mdx | 6 +++--- 105 files changed, 353 insertions(+), 327 deletions(-) diff --git a/docs/sdks/api/conversation/changeInputStates.mdx b/docs/sdks/api/conversation/changeInputStates.mdx index ec7137257f..6f967ca6fb 100644 --- a/docs/sdks/api/conversation/changeInputStates.mdx +++ b/docs/sdks/api/conversation/changeInputStates.mdx @@ -252,7 +252,7 @@ IMSDK.asyncApi('changeInputStates', IMSDK.uuid(), { OpenIMSDKRN.changeInputStates({ conversationID: string, focus: boolean, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -261,13 +261,13 @@ OpenIMSDKRN.changeInputStates({ | -------------- | -------- | -------- | ------- | | conversationID | string | 是 | 会话 ID | | focus | boolean | 是 | 是否正在输入 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx b/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx index 5c7be52615..55378f04e0 100644 --- a/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx +++ b/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx @@ -229,21 +229,21 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.clearConversationAndDeleteAllMsg(operationID: string, conversationID: string): Promise +OpenIMSDKRN.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx b/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx index 9d74dfb2fc..627c3756d1 100644 --- a/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx +++ b/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx @@ -223,21 +223,21 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteConversationAndDeleteAllMsg(operationID: string, conversationID: string): Promise +OpenIMSDKRN.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getAllConversationList.mdx b/docs/sdks/api/conversation/getAllConversationList.mdx index c4d48ad22d..a79de9b0f2 100644 --- a/docs/sdks/api/conversation/getAllConversationList.mdx +++ b/docs/sdks/api/conversation/getAllConversationList.mdx @@ -218,21 +218,21 @@ IMSDK.asyncApi('getAllConversationList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getAllConversationList(operationID: string): Promise +OpenIMSDKRN.getAllConversationList(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| 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)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getConversationIDBySessionType.mdx b/docs/sdks/api/conversation/getConversationIDBySessionType.mdx index 8f14161d67..942732eb65 100644 --- a/docs/sdks/api/conversation/getConversationIDBySessionType.mdx +++ b/docs/sdks/api/conversation/getConversationIDBySessionType.mdx @@ -230,16 +230,16 @@ IMSDK.asyncApi('getConversationIDBySessionType', IMSDK.uuid(), { OpenIMSDKRN.getConversationIDBySessionType({ sourceID: string, sessionType: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------------------------------------------------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) | | sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 是 | 会话类型 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -247,7 +247,7 @@ OpenIMSDKRN.getConversationIDBySessionType({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getConversationListSplit.mdx b/docs/sdks/api/conversation/getConversationListSplit.mdx index 958e39ae2c..869ec643ed 100644 --- a/docs/sdks/api/conversation/getConversationListSplit.mdx +++ b/docs/sdks/api/conversation/getConversationListSplit.mdx @@ -248,16 +248,16 @@ IMSDK.asyncApi('getConversationListSplit', IMSDK.uuid(), { OpenIMSDKRN.getConversationListSplit({ offset: number, count: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | offset | number | 是 | 分页拉取起始下标 | | count | number | 是 | 一页拉取的数量 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -265,7 +265,7 @@ OpenIMSDKRN.getConversationListSplit({ | 参数名称 | 参数类型 | 描述 | | --------------- | -------------------------------------------------------------------------------- | ------------ | | 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)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getInputStates.mdx b/docs/sdks/api/conversation/getInputStates.mdx index 66d2369fea..cd10ef41ce 100644 --- a/docs/sdks/api/conversation/getInputStates.mdx +++ b/docs/sdks/api/conversation/getInputStates.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('getInputstates', IMSDK.uuid(), { OpenIMSDKRN.getInputstates({ conversationID: string, userID: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -259,13 +259,13 @@ OpenIMSDKRN.getInputstates({ | -------------- | -------- | -------- | ------- | | conversationID | string | 是 | 会话 ID | | userID | string | 是 | 用户ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[Response](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getMultipleConversation.mdx b/docs/sdks/api/conversation/getMultipleConversation.mdx index de3c826532..485146bfb6 100644 --- a/docs/sdks/api/conversation/getMultipleConversation.mdx +++ b/docs/sdks/api/conversation/getMultipleConversation.mdx @@ -220,23 +220,22 @@ IMSDK.asyncApi('getMultipleConversation', IMSDK.uuid(), ['conversationID']) ```ts showLineNumbers OpenIMSDKRN.getMultipleConversation({ conversationIDList: string[], -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ------------------ | -------- | -------- | ------------------------------------------------------- | -| 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)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getOneConversation.mdx b/docs/sdks/api/conversation/getOneConversation.mdx index b0d8831500..6e476b27d0 100644 --- a/docs/sdks/api/conversation/getOneConversation.mdx +++ b/docs/sdks/api/conversation/getOneConversation.mdx @@ -243,24 +243,23 @@ IMSDK.asyncApi('getOneConversation', IMSDK.uuid(), { OpenIMSDKRN.getOneConversation({ sessionType: number, sourceID: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------------------------------------------------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | sourceID | string | 是 | 会话的用户 ID(单聊)或 groupID(群聊) | | sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 是 | 会话类型 | - +| 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)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx b/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx index fdb8dffbb4..89a83d1daf 100644 --- a/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx +++ b/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx @@ -211,21 +211,21 @@ IMSDK.asyncApi('getTotalUnreadMsgCount', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getTotalUnreadMsgCount(operationID: string): Promise +OpenIMSDKRN.getTotalUnreadMsgCount(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/hideAllConversation.mdx b/docs/sdks/api/conversation/hideAllConversation.mdx index d14b1e0ca8..98f3f615ef 100644 --- a/docs/sdks/api/conversation/hideAllConversation.mdx +++ b/docs/sdks/api/conversation/hideAllConversation.mdx @@ -171,14 +171,14 @@ IMSDK.deleteAllConversationFromLocal() ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.hideAllConversations(operationID: string): Promise +OpenIMSDKRN.hideAllConversations(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 diff --git a/docs/sdks/api/conversation/hideConversation.mdx b/docs/sdks/api/conversation/hideConversation.mdx index a8756ab2b5..8cd7ac6dad 100644 --- a/docs/sdks/api/conversation/hideConversation.mdx +++ b/docs/sdks/api/conversation/hideConversation.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('hideConversation', IMSDK.uuid(), 'conversationID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.hideConversation(conversationID: string, operationID: string): Promise +OpenIMSDKRN.hideConversation(conversationID: string, operationID?: string): Promise ``` ### 输入参数 @@ -226,14 +226,14 @@ OpenIMSDKRN.hideConversation(conversationID: string, operationID: string): Promi | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | | conversationID | string | 是 | 会话 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.then() | Promise<[void](docs/sdks/class/response.mdx)\> | 调用成功回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx index d063dd6576..73f8e44e25 100644 --- a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx +++ b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx @@ -233,22 +233,22 @@ IMSDK.asyncApi('markConversationMessageAsRead', IMSDK.uuid(), 'conversationID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.markConversationMessageAsRead(operationID: string, conversationID: string): Promise +OpenIMSDKRN.markConversationMessageAsRead(conversationID: string, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/setConversation.mdx b/docs/sdks/api/conversation/setConversation.mdx index f67171f217..13ed7bc7d2 100644 --- a/docs/sdks/api/conversation/setConversation.mdx +++ b/docs/sdks/api/conversation/setConversation.mdx @@ -276,7 +276,7 @@ OpenIMSDKRN.setConversation({ isPinned?: boolean; isPrivateChat?: boolean; ex?: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -296,7 +296,7 @@ OpenIMSDKRN.setConversation({ | 参数名称 | 参数类型 | 描述 | | --------------- | -------------------------------------------------------- | ------------ | | Promise.then() | Promise\ | 调用成功回调 | -| Promise.catch() | Promise\<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise\<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/conversation/setConversationDraft.mdx b/docs/sdks/api/conversation/setConversationDraft.mdx index 9bef371b67..79bb508c1d 100644 --- a/docs/sdks/api/conversation/setConversationDraft.mdx +++ b/docs/sdks/api/conversation/setConversationDraft.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('setConversationDraft', IMSDK.uuid(), { OpenIMSDKRN.setConversationDraft({ conversationID: string, draftText: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -259,14 +259,14 @@ OpenIMSDKRN.setConversationDraft({ | -------------- | -------- | -------- | ------------------------------------------------------- | | conversationID | string | 是 | 会话 ID | | draftText | string | 是 | 草稿内容 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise\ | 调用成功回调 | -| Promise.catch() | Promise\<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise\<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/acceptGroupApplication.mdx b/docs/sdks/api/group/acceptGroupApplication.mdx index 81d8c26ac1..86f2a3e52c 100644 --- a/docs/sdks/api/group/acceptGroupApplication.mdx +++ b/docs/sdks/api/group/acceptGroupApplication.mdx @@ -276,7 +276,7 @@ OpenIMSDKRN.acceptGroupApplication({ groupID: string, fromUserID: string, handleMsg: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -286,14 +286,14 @@ OpenIMSDKRN.acceptGroupApplication({ | groupID | string | 是 | 群ID | | fromUserID | string | 是 | 申请发起者用户 ID | | handleMsg | string | 是 | 操作信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/changeGroupMemberMute.mdx b/docs/sdks/api/group/changeGroupMemberMute.mdx index d5fe1b0e46..f8a1eccb8d 100644 --- a/docs/sdks/api/group/changeGroupMemberMute.mdx +++ b/docs/sdks/api/group/changeGroupMemberMute.mdx @@ -277,7 +277,7 @@ OpenIMSDKRN.changeGroupMemberMute({ groupID: string, userID: string, mutedSeconds: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -287,14 +287,14 @@ OpenIMSDKRN.changeGroupMemberMute({ | groupID | string | 是 | 群ID | | userID | string | 是 | 要操作的群成员用户 ID | | mutedSeconds | number | 是 | 要禁言的时长，单位秒。为 0 时取消禁言 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/changeGroupMute.mdx b/docs/sdks/api/group/changeGroupMute.mdx index 3c5fa2e9c5..96e38c077b 100644 --- a/docs/sdks/api/group/changeGroupMute.mdx +++ b/docs/sdks/api/group/changeGroupMute.mdx @@ -262,7 +262,7 @@ IMSDK.asyncApi('changeGroupMute', IMSDK.uuid(), { OpenIMSDKRN.changeGroupMute({ groupID: string, isMute: boolean, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -271,7 +271,7 @@ OpenIMSDKRN.changeGroupMute({ | ----------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | | isMute | boolean | 是 | 是否禁言 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -279,7 +279,7 @@ OpenIMSDKRN.changeGroupMute({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/createGroup.mdx b/docs/sdks/api/group/createGroup.mdx index a2d970cf8b..17630cc815 100644 --- a/docs/sdks/api/group/createGroup.mdx +++ b/docs/sdks/api/group/createGroup.mdx @@ -296,7 +296,7 @@ OpenIMSDKRN.createGroup({ memberUserIDs: string[], adminUserIDs?: string[], ownerUserID?: string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -307,7 +307,7 @@ OpenIMSDKRN.createGroup({ | memberUserIDs | string[] | 是 | 邀请进入的群成员列表 | | adminUserIDs | string[] | 否 | 邀请进入并设为管理员的列表 | | ownerUserID | string | 否 | 群主 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -315,7 +315,7 @@ OpenIMSDKRN.createGroup({ | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------- | ------------ | | Promise.then() | Promise<[GroupItem](docs/sdks/class/group/groupInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/dismissGroup.mdx b/docs/sdks/api/group/dismissGroup.mdx index 4570f144e0..a0894588dd 100644 --- a/docs/sdks/api/group/dismissGroup.mdx +++ b/docs/sdks/api/group/dismissGroup.mdx @@ -240,7 +240,7 @@ IMSDK.asyncApi('dismissGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.dismissGroup(groupID: string, operationID: string): Promise +OpenIMSDKRN.dismissGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -248,14 +248,14 @@ OpenIMSDKRN.dismissGroup(groupID: string, operationID: string): Promise | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx b/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx index 35bdc41341..fceb790431 100644 --- a/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx +++ b/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx @@ -235,21 +235,30 @@ IMSDK.asyncApi('getGroupApplicationListAsApplicant', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupApplicationListAsApplicant(operationID: string): Promise +OpenIMSDKRN.getGroupApplicationListAsApplicant(req: { + groupIDs: string[]; + handleResults: number[] + offset: number; + count: number; +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| groupIDs | string[] | 是 | 群组 ID 列表 | +| handleResults | number[] | 是 | - | +| offset | number | 是 | 分页拉取起始下标 | +| count | number | 是 | 一页拉取的数量 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------------------- | ------------------ | | Promise.then() | Promise<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)[]\> | 发出的加群请求列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx b/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx index 5501f99cd1..0a4762e331 100644 --- a/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx +++ b/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx @@ -236,21 +236,30 @@ IMSDK.asyncApi('getGroupApplicationListAsRecipient', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupApplicationListAsRecipient(operationID: string): Promise +OpenIMSDKRN.getGroupApplicationListAsRecipient(req: { + groupIDs: string[]; + handleResults: number[] + offset: number; + count: number; +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| groupIDs | string[] | 是 | 群组 ID 列表 | +| handleResults | number[] | 是 | - | +| offset | number | 是 | 分页拉取起始下标 | +| count | number | 是 | 一页拉取的数量 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------------------- | ------------------ | | Promise.then() | Promise<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)[]\> | 发出的加群请求列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getGroupMemberList.mdx b/docs/sdks/api/group/getGroupMemberList.mdx index d293508e7d..da16920f35 100644 --- a/docs/sdks/api/group/getGroupMemberList.mdx +++ b/docs/sdks/api/group/getGroupMemberList.mdx @@ -288,7 +288,7 @@ OpenIMSDKRN.getGroupMemberList({ filter: GroupMemberFilter, offset: number, count: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -299,14 +299,14 @@ OpenIMSDKRN.getGroupMemberList({ | filter | [GroupMemberFilter](docs/sdks/enum/groupMemberFilter.mdx) | 是 | 群成员角色 | | offset | number | 是 | 起始偏移，分页拉取使用 | | count | number | 是 | 分页拉取，一页拉取的成员个数 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)[]\> | 群成员列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx b/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx index 308eb8329f..3e1204d635 100644 --- a/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx +++ b/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx @@ -309,7 +309,7 @@ OpenIMSDKRN.getGroupMemberListByJoinTimeFilter({ joinTimeBegin: number, joinTimeEnd: number, filterUserIDList: string[], -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -322,14 +322,14 @@ OpenIMSDKRN.getGroupMemberListByJoinTimeFilter({ | joinTimeBegin | number | 是 | 最早加入时间，为 0 时不限制 | | joinTimeEnd | number | 是 | 最晚加入时间，为 0 时不限制 | | filterUserIDList | string[] | 是 | 需要排除的群成员 userID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)[]\> | 群成员列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx b/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx index 6e45720903..f1d4972c04 100644 --- a/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx +++ b/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx @@ -231,7 +231,7 @@ IMSDK.asyncApi('getGroupMemberOwnerAndAdmin', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupMemberOwnerAndAdmin(groupID: string, operationID: string): Promise +OpenIMSDKRN.getGroupMemberOwnerAndAdmin(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -239,14 +239,14 @@ OpenIMSDKRN.getGroupMemberOwnerAndAdmin(groupID: string, operationID: string): P | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)[]\> | 群成员列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getJoinedGroupList.mdx b/docs/sdks/api/group/getJoinedGroupList.mdx index 7eec62b7e4..83480ce6d7 100644 --- a/docs/sdks/api/group/getJoinedGroupList.mdx +++ b/docs/sdks/api/group/getJoinedGroupList.mdx @@ -216,21 +216,21 @@ IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getJoinedGroupList(operationID: string): Promise +OpenIMSDKRN.getJoinedGroupList(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------ | -------------- | | Promise.then() | Promise<[GroupItem](docs/sdks/class/group/groupInfo.mdx)[]\> | 加入的群组列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getJoinedGroupListPage.mdx b/docs/sdks/api/group/getJoinedGroupListPage.mdx index dc469b7bc0..5444c9086d 100644 --- a/docs/sdks/api/group/getJoinedGroupListPage.mdx +++ b/docs/sdks/api/group/getJoinedGroupListPage.mdx @@ -245,7 +245,7 @@ IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid(), { offset: 0, count: 1000 }) OpenIMSDKRN.getJoinedGroupList({ offset: number; count: number; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -254,14 +254,14 @@ OpenIMSDKRN.getJoinedGroupList({ | -------- | -------- | -------- | ------- | | offset | number | 是 | 分页拉取起始下标 | | count | number | 是 | 一页拉取的数量 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------ | -------------- | | Promise.then() | Promise<[GroupItem](docs/sdks/class/group/groupInfo.mdx)[]\> | 加入的群组列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx b/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx index 0a9b0fd739..d88730dbaf 100644 --- a/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx +++ b/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx @@ -260,7 +260,7 @@ IMSDK.asyncApi('getSpecifiedGroupMembersInfo', IMSDK.uuid(), { OpenIMSDKRN.getSpecifiedGroupMembersInfo({ groupID: string, userIDList: string[], -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -269,14 +269,14 @@ OpenIMSDKRN.getSpecifiedGroupMembersInfo({ | ----------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | | userIDList | string[] | 是 | 群成员 ID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)[]\> | 群成员列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx b/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx index 2ea2249c74..36141c49bb 100644 --- a/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx +++ b/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx @@ -233,14 +233,14 @@ IMSDK.asyncApi('getSpecifiedGroupsInfo', IMSDK.uuid(), groupIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID: string): Promise +OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | groupIDList | string[] | 是 | 群组 ID 列表 | ### 返回结果 @@ -248,7 +248,7 @@ OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID: string): | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[GroupInfo](docs/sdks/class/group/groupInfo.mdx)[]\> | 群组信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/getUsersInGroup.mdx b/docs/sdks/api/group/getUsersInGroup.mdx index 97660fdf14..23fb80403e 100644 --- a/docs/sdks/api/group/getUsersInGroup.mdx +++ b/docs/sdks/api/group/getUsersInGroup.mdx @@ -253,7 +253,7 @@ IMSDK.asyncApi('getUsersInGroup', IMSDK.uuid(), { OpenIMSDKRN.getUsersInGroup({ groupID: string; userIDList: string[]; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -262,14 +262,14 @@ OpenIMSDKRN.getUsersInGroup({ | -------- | -------- | -------- | ------- | | groupID | string | 是 | 群ID | | userIDList | string[] | 是 | 用户ID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/inviteUserToGroup.mdx b/docs/sdks/api/group/inviteUserToGroup.mdx index 32598236fc..e3127cd622 100644 --- a/docs/sdks/api/group/inviteUserToGroup.mdx +++ b/docs/sdks/api/group/inviteUserToGroup.mdx @@ -289,7 +289,7 @@ OpenIMSDKRN.inviteUserToGroup({ groupID: string, reason: string, userIDList: string[], -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -299,14 +299,14 @@ OpenIMSDKRN.inviteUserToGroup({ | groupID | string | 是 | 群ID | | reason | string | 是 | 邀请信息 | | userIDList | string[] | 是 | 被邀请用户 userID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/isJoinGroup.mdx b/docs/sdks/api/group/isJoinGroup.mdx index 1db3942bab..518f2eb90a 100644 --- a/docs/sdks/api/group/isJoinGroup.mdx +++ b/docs/sdks/api/group/isJoinGroup.mdx @@ -229,7 +229,7 @@ IMSDK.asyncApi('isJoinGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.isJoinGroup(groupID: string, operationID: string): Promise +OpenIMSDKRN.isJoinGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -237,14 +237,14 @@ OpenIMSDKRN.isJoinGroup(groupID: string, operationID: string): Promise | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/joinGroup.mdx b/docs/sdks/api/group/joinGroup.mdx index a7744ab65c..dc1508be76 100644 --- a/docs/sdks/api/group/joinGroup.mdx +++ b/docs/sdks/api/group/joinGroup.mdx @@ -266,7 +266,7 @@ OpenIMSDKRN.joinGroup({ groupID: string, reqMsg: string, joinSource: GroupJoinSource.Search, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -276,14 +276,14 @@ OpenIMSDKRN.joinGroup({ | groupID | string | 是 | 群ID | | reqMsg | string | 是 | 入群申请信息 | | joinSource | [GroupJoinSource](docs/sdks/enum/joinSource.mdx) | 是 | 加入途径 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/kickGroupMember.mdx b/docs/sdks/api/group/kickGroupMember.mdx index c630720bbb..866d1f3d74 100644 --- a/docs/sdks/api/group/kickGroupMember.mdx +++ b/docs/sdks/api/group/kickGroupMember.mdx @@ -291,7 +291,7 @@ OpenIMSDKRN.kickGroupMember({ groupID: string, reason: string, userIDList: string[], -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -301,14 +301,14 @@ OpenIMSDKRN.kickGroupMember({ | groupID | string | 是 | 群ID | | reason | string | 是 | 踢出原因 | | userIDList | string[] | 是 | 提出用户 ID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/quitGroup.mdx b/docs/sdks/api/group/quitGroup.mdx index 3b5837e604..9457c7e298 100644 --- a/docs/sdks/api/group/quitGroup.mdx +++ b/docs/sdks/api/group/quitGroup.mdx @@ -240,21 +240,20 @@ IMSDK.asyncApi('quitGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.quitGroup(groupID: string, operationID: string): Promise +OpenIMSDKRN.quitGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | groupID | string | 是 | 群ID | - +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/refuseGroupApplication.mdx b/docs/sdks/api/group/refuseGroupApplication.mdx index cc4a91bcd3..e5f3187015 100644 --- a/docs/sdks/api/group/refuseGroupApplication.mdx +++ b/docs/sdks/api/group/refuseGroupApplication.mdx @@ -273,7 +273,7 @@ OpenIMSDKRN.refuseGroupApplication({ groupID: string, fromUserID: string, handleMsg: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -283,14 +283,14 @@ OpenIMSDKRN.refuseGroupApplication({ | groupID | string | 是 | 群ID | | fromUserID | string | 是 | 申请者 userID | | handleMsg | string | 是 | 拒绝原因 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/searchGroupMembers.mdx b/docs/sdks/api/group/searchGroupMembers.mdx index ac114cbcda..904f538dd5 100644 --- a/docs/sdks/api/group/searchGroupMembers.mdx +++ b/docs/sdks/api/group/searchGroupMembers.mdx @@ -305,7 +305,7 @@ OpenIMSDKRN.searchGroupMembers({ isSearchMemberNickname: boolean; offset: number; count: number; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -316,7 +316,7 @@ OpenIMSDKRN.searchGroupMembers({ | isSearchUserID | boolean | 是 | 是否以关键词搜索 userID | | isSearchNickname | boolean | 是 | 是否以关键词搜索昵称 | | isSearchRemark | boolean | 是 | 是否以关键词搜索备注 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | offset | number | 是 | 起始偏移，分页拉取使用 | | count | number | 是 | 分页拉取，一页拉取的成员个数 | @@ -325,7 +325,7 @@ OpenIMSDKRN.searchGroupMembers({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------ | ---------------------- | | Promise.then() | Promise<[GroupMemberItem](docs/sdks/class/group/groupMemberInfo.mdx)[]\> | 搜索到的群成员信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/searchGroups.mdx b/docs/sdks/api/group/searchGroups.mdx index 825cf8fcc1..e5f4f93ceb 100644 --- a/docs/sdks/api/group/searchGroups.mdx +++ b/docs/sdks/api/group/searchGroups.mdx @@ -266,7 +266,7 @@ OpenIMSDKRN.searchGroups({ keywordList: string[]; isSearchGroupID: boolean; isSearchGroupName: boolean; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -276,14 +276,14 @@ OpenIMSDKRN.searchGroups({ | keywordList | string[] | 是 | 搜索关键词，目前仅支持一个关键词搜索，不能为空 | | isSearchGroupID | boolean | 是 | 是否以关键词搜索群ID | | isSearchGroupName | boolean | 是 | 是否以关键词搜索群名称 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------ | -------------------- | | Promise.then() | Promise<[GroupItem](docs/sdks/class/group/groupInfo.mdx)[]\> | 搜索到的群信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/setGroupInfo.mdx b/docs/sdks/api/group/setGroupInfo.mdx index aef93310de..ceab634166 100644 --- a/docs/sdks/api/group/setGroupInfo.mdx +++ b/docs/sdks/api/group/setGroupInfo.mdx @@ -285,14 +285,14 @@ OpenIMSDKRN.setGroupInfo({ applyMemberFriend?: AllowType; lookMemberInfo?: AllowType; ex?: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | ------------------------------------------------------------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | groupID | string | 是 | 群组 ID | | faceURL | string | 否 | 群头像 | | groupName | string | 否 | 群名称 | @@ -308,7 +308,7 @@ OpenIMSDKRN.setGroupInfo({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/setGroupMemberInfo.mdx b/docs/sdks/api/group/setGroupMemberInfo.mdx index 041c5d378a..4255db47ac 100644 --- a/docs/sdks/api/group/setGroupMemberInfo.mdx +++ b/docs/sdks/api/group/setGroupMemberInfo.mdx @@ -266,7 +266,7 @@ OpenIMSDKRN.setGroupMemberInfo({ faceURL?: string; roleLevel?: GroupMemberRole; ex?: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -279,14 +279,14 @@ OpenIMSDKRN.setGroupMemberInfo({ | faceURL | string | 否 | 群成员头像URL | | roleLevel | string | 否 | 群成员角色 | | ex | string | 否 | 群成员扩展信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/group/transferGroupOwner.mdx b/docs/sdks/api/group/transferGroupOwner.mdx index 1ea0693475..00a45b10f9 100644 --- a/docs/sdks/api/group/transferGroupOwner.mdx +++ b/docs/sdks/api/group/transferGroupOwner.mdx @@ -265,7 +265,7 @@ IMSDK.asyncApi('transferGroupOwner', IMSDK.uuid(), { OpenIMSDKRN.transferGroupOwner({ groupID: string, newOwnerUserID: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -274,14 +274,14 @@ OpenIMSDKRN.transferGroupOwner({ | -------------- | -------- | -------- | ------------------------------------------------------- | | groupID | string | 是 | 群ID | | newOwnerUserID | string | 是 | 新群主用户 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/initialization/getLoginStatus.mdx b/docs/sdks/api/initialization/getLoginStatus.mdx index 80cb2fc70c..4a93af785e 100644 --- a/docs/sdks/api/initialization/getLoginStatus.mdx +++ b/docs/sdks/api/initialization/getLoginStatus.mdx @@ -193,21 +193,21 @@ IMSDK.asyncApi('getLoginStatus', 'operationID'); ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.getLoginStatus(operationID: string): Promise +OpenIMSDKRN.getLoginStatus(operationID?: string): Promise ``` ### 输入参数 -| 参数名称 | 参数类型 | 描述 | -| -------- | -------- | --------------------------------------- | -| operationID | string | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------- | -------- | -------- | --------------------------------------- | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ---------------- | | Promise.then() | Promise<[LoginStatus](docs/sdks/enum/loginStatus.mdx)\> | 当前用户登录状态 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/initialization/getLoginUserID.mdx b/docs/sdks/api/initialization/getLoginUserID.mdx index b22c6e76f9..e5e08ff288 100644 --- a/docs/sdks/api/initialization/getLoginUserID.mdx +++ b/docs/sdks/api/initialization/getLoginUserID.mdx @@ -189,7 +189,7 @@ IMSDK.asyncApi('getLoginUserID', 'operationID') ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.getLoginUserID(operationID: string): Promise +OpenIMSDKRN.getLoginUserID(operationID?: string): Promise ``` ### 返回结果 @@ -197,7 +197,7 @@ OpenIMSDKRN.getLoginUserID(operationID: string): Promise | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | --------------- | | Promise.then() | Promise | 当前登录用户 ID | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/initialization/initSDK.mdx b/docs/sdks/api/initialization/initSDK.mdx index 622281026d..2c3e3c9228 100644 --- a/docs/sdks/api/initialization/initSDK.mdx +++ b/docs/sdks/api/initialization/initSDK.mdx @@ -320,8 +320,8 @@ export const getDbDir = () => ### 函数原型 -```js showLineNumbers -OpenIMSDKRN.initSDK(config: InitConfig, optionalID:string): Promise +```ts showLineNumbers +OpenIMSDKRN.initSDK(config: InitConfig, optionalID? :string): Promise ``` ### 输入参数 @@ -329,17 +329,17 @@ OpenIMSDKRN.initSDK(config: InitConfig, optionalID:string): Promise | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------- | ------------------------------------------------ | -------- | ---------- | | config | [InitConfig](docs/sdks/class/init/config.mdx) | 是 | 初始化参数 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数| +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数| ### 返回结果 - + | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | -------------- | | Promise.then() | Promise | 是否初始化成功 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | + ### 代码示例 - + ```ts showLineNumbers import OpenIMSDKRN from 'open-im-sdk-rn'; import RNFS from 'react-native-fs'; diff --git a/docs/sdks/api/initialization/login.mdx b/docs/sdks/api/initialization/login.mdx index 2e5801df32..3270921418 100644 --- a/docs/sdks/api/initialization/login.mdx +++ b/docs/sdks/api/initialization/login.mdx @@ -293,7 +293,7 @@ IMSDK.asyncApi('login', IMSDK.uuid(), { OpenIMSDKRN.login({ userID:string, token:string -}, operationID:string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -302,14 +302,14 @@ OpenIMSDKRN.login({ | ----------- | -------- | -------- | ------------------------------------------------------------------- | --- | | userID | String | 是 | IM 用户 userID | | token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | | -| operationID | String | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | String | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/initialization/logout.mdx b/docs/sdks/api/initialization/logout.mdx index 9a083b7cda..a5c32df100 100644 --- a/docs/sdks/api/initialization/logout.mdx +++ b/docs/sdks/api/initialization/logout.mdx @@ -224,21 +224,21 @@ IMSDK.asyncApi('logout', IMSDK.uuid()) ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.logout(operationID: string): Promise +OpenIMSDKRN.logout(operationID?: string): Promise ``` ### 参数详解 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------- | --------------------------------------- | -------- | -------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/initialization/unInitSDK.mdx b/docs/sdks/api/initialization/unInitSDK.mdx index 6656971399..3f735d1bea 100644 --- a/docs/sdks/api/initialization/unInitSDK.mdx +++ b/docs/sdks/api/initialization/unInitSDK.mdx @@ -146,21 +146,21 @@ IMSDK.asyncApi('unInitSDK', IMSDK.uuid(), config) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.unInitSDK(operationID: string): Promise +OpenIMSDKRN.unInitSDK(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | --------------------------------------------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | -------------- | | Promise.then() | Promise | 是否反初始化成功 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createCardMessage.mdx b/docs/sdks/api/message/createCardMessage.mdx index 42d432203c..c05f78c67d 100644 --- a/docs/sdks/api/message/createCardMessage.mdx +++ b/docs/sdks/api/message/createCardMessage.mdx @@ -253,7 +253,7 @@ OpenIMSDKRN.login({ nickname:string, faceURL:string, ex:string -}, operationID:string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -264,14 +264,14 @@ OpenIMSDKRN.login({ | nickname | string | 是 | 用户昵称 | | faceURL | string | 是 | 用户头像URL | | ex | string | 是 | 扩展信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 ```js showLineNumbers diff --git a/docs/sdks/api/message/createCustomMessage.mdx b/docs/sdks/api/message/createCustomMessage.mdx index 3eec01f701..96eb152341 100644 --- a/docs/sdks/api/message/createCustomMessage.mdx +++ b/docs/sdks/api/message/createCustomMessage.mdx @@ -248,7 +248,7 @@ OpenIMSDKRN.createCustomMessage({ data: string, extension: string, description: string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -258,14 +258,14 @@ OpenIMSDKRN.createCustomMessage({ | data | String | 是 | 文本内容 | | extension | String | 是 | 拓展内容 | | description | String | 是 | 描述内容 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createFaceMessage.mdx b/docs/sdks/api/message/createFaceMessage.mdx index 1933519e06..11911f3e7f 100644 --- a/docs/sdks/api/message/createFaceMessage.mdx +++ b/docs/sdks/api/message/createFaceMessage.mdx @@ -241,7 +241,7 @@ IMSDK.asyncApi('createFaceMessage', IMSDK.uuid(), { OpenIMSDKRN.createFaceMessage({ index: number; dataStr: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -250,7 +250,7 @@ OpenIMSDKRN.createFaceMessage({ | ----------- | -------- | -------- | ------------------------------------------------------- | | index | number | 是 | 索引 | | dataStr | string | 是 | 内容 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -258,7 +258,7 @@ OpenIMSDKRN.createFaceMessage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createFileMessageByURL.mdx b/docs/sdks/api/message/createFileMessageByURL.mdx index e7a721f13e..7abb3da5ee 100644 --- a/docs/sdks/api/message/createFileMessageByURL.mdx +++ b/docs/sdks/api/message/createFileMessageByURL.mdx @@ -264,7 +264,7 @@ OpenIMSDKRN.createFileMessageByURL( { sourceUrl: string, fileSize: number, fileType: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -277,14 +277,14 @@ OpenIMSDKRN.createFileMessageByURL( { | sourceUrl | string | 是 | 图片下载地址，自行上文件后获得的远程 url 地址，需要通过[sendMessageNotOss](docs/sdks/api/message/sendMessageNotOss.mdx) 发送 | | fileSize | string | 是 | 文件大小 | | fileType | string | 是 | 文件类型，一般为后缀名 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 ```js showLineNumbers diff --git a/docs/sdks/api/message/createFileMessageFromFullPath.mdx b/docs/sdks/api/message/createFileMessageFromFullPath.mdx index 08a1fc75c4..efccb23098 100644 --- a/docs/sdks/api/message/createFileMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createFileMessageFromFullPath.mdx @@ -232,7 +232,7 @@ IMSDK.asyncApi('createFileMessageFromFullPath', IMSDK.uuid(), { OpenIMSDKRN.createFileMessageFromFullPath({ filePath: string, fileName: string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -241,14 +241,14 @@ OpenIMSDKRN.createFileMessageFromFullPath({ | ----------- | -------- | -------- | ------------------------------------------------------- | | filePath | number | 是 | 文件绝对路径 | | fileName | string | 是 | 文件名称 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | diff --git a/docs/sdks/api/message/createForwardMessage.mdx b/docs/sdks/api/message/createForwardMessage.mdx index ad6abbcea2..c4937a8920 100644 --- a/docs/sdks/api/message/createForwardMessage.mdx +++ b/docs/sdks/api/message/createForwardMessage.mdx @@ -215,7 +215,7 @@ IMSDK.asyncApi('createForwardMessage', IMSDK.uuid(), message) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createForwardMessage( message: MessageItem, operationID: string): Promise +OpenIMSDKRN.createForwardMessage( message: MessageItem, operationID?: string): Promise ``` ### 输入参数 @@ -223,14 +223,14 @@ OpenIMSDKRN.createForwardMessage( message: MessageItem, operationID: string): Pr | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | | message | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 是 | 要转发的消息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createImageMessageByURL.mdx b/docs/sdks/api/message/createImageMessageByURL.mdx index 7fb5afab77..72cd5662d7 100644 --- a/docs/sdks/api/message/createImageMessageByURL.mdx +++ b/docs/sdks/api/message/createImageMessageByURL.mdx @@ -288,7 +288,7 @@ OpenIMSDKRN.createImageMessageByURL({ sourcePicture: PicBaseInfo, bigPicture: PicBaseInfo, snapshotPicture: PicBaseInfo, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -299,13 +299,14 @@ OpenIMSDKRN.createImageMessageByURL({ | bigPicture | [PicBaseInfo](docs/sdks/class/message/pictureInfo.mdx) | 是 | 大图相关信息 | | snapshotPicture | [PicBaseInfo](docs/sdks/class/message/pictureInfo.mdx) | 是 | 缩略图相关信息 | | sourcePath | string | 是 | 图片在本机的绝对路径，如果没有传空字符即可 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | + ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createImageMessageFromFullPath.mdx b/docs/sdks/api/message/createImageMessageFromFullPath.mdx index b75b0ea909..550a2fc43e 100644 --- a/docs/sdks/api/message/createImageMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createImageMessageFromFullPath.mdx @@ -213,14 +213,14 @@ IMSDK.asyncApi('createImageMessageFromFullPath', IMSDK.uuid(), 'imagePath') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createImageMessageFromFullPath(imagePath: string, operationID: string): Promise +OpenIMSDKRN.createImageMessageFromFullPath(imagePath: string, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | imagePath | string | 是 | 图片绝对路径 | ### 返回结果 @@ -228,7 +228,7 @@ OpenIMSDKRN.createImageMessageFromFullPath(imagePath: string, operationID: strin | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createLocationMessage.mdx b/docs/sdks/api/message/createLocationMessage.mdx index ee1d58cc16..2a53d0f406 100644 --- a/docs/sdks/api/message/createLocationMessage.mdx +++ b/docs/sdks/api/message/createLocationMessage.mdx @@ -249,7 +249,7 @@ OpenIMSDKRN.createLocationMessage({ description: string, longitude: number, latitude: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -259,14 +259,14 @@ OpenIMSDKRN.createLocationMessage({ | description | string | 是 | 位置描述 | | latitude | number | 是 | 纬度 | | longitude | number | 是 | 经度 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createMergeMessage.mdx b/docs/sdks/api/message/createMergeMessage.mdx index 73c2e9726d..9e51779d82 100644 --- a/docs/sdks/api/message/createMergeMessage.mdx +++ b/docs/sdks/api/message/createMergeMessage.mdx @@ -261,7 +261,7 @@ OpenIMSDKRN.createMergerMessage({ title: string, messageList: Array, summaryList: Array, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -271,14 +271,14 @@ OpenIMSDKRN.createMergerMessage({ | messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 是 | 消息列表 | | title | string | 是 | 标题 | | summaryList | string[] | 是 | 消息摘要列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createQuoteMessage.mdx b/docs/sdks/api/message/createQuoteMessage.mdx index a587dde08a..d6ef96ad5e 100644 --- a/docs/sdks/api/message/createQuoteMessage.mdx +++ b/docs/sdks/api/message/createQuoteMessage.mdx @@ -238,14 +238,14 @@ IMSDK.asyncApi('createQuoteMessage', IMSDK.uuid(), { OpenIMSDKRN.createQuoteMessage({ text: string, message: MessageItem, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | text | string | 是 | 文本内容 | | message | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 是 | 被引用消息 | @@ -254,7 +254,7 @@ OpenIMSDKRN.createQuoteMessage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createSoundMessageByURL.mdx b/docs/sdks/api/message/createSoundMessageByURL.mdx index 2e60bdf6c3..230c557fbf 100644 --- a/docs/sdks/api/message/createSoundMessageByURL.mdx +++ b/docs/sdks/api/message/createSoundMessageByURL.mdx @@ -264,7 +264,7 @@ OpenIMSDKRN.createSoundMessageByURL({ dataSize: number, duration: number, soundType: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -277,14 +277,14 @@ OpenIMSDKRN.createSoundMessageByURL({ | sourceUrl | string | 是 | 图片下载地址，自行上文件并通过[sendMessageNotOss](docs/sdks/api/message/sendMessageNotOss.mdx) 发送时，需要传入远程 url，否则为空字符串 | | dataSize | string | 是 | 文件大小 | | soundType | string | 是 | 文件类型，一般为后缀名 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createSoundMessageFromFullPath.mdx b/docs/sdks/api/message/createSoundMessageFromFullPath.mdx index 89a9579678..3da8635705 100644 --- a/docs/sdks/api/message/createSoundMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createSoundMessageFromFullPath.mdx @@ -229,7 +229,7 @@ IMSDK.asyncApi('createSoundMessageFromFullPath', IMSDK.uuid(), { OpenIMSDKRN.createSoundMessageFromFullPath({ soundPath: string, duration: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -238,14 +238,14 @@ OpenIMSDKRN.createSoundMessageFromFullPath({ | ----------- | -------- | -------- | ------------------------------------------------------- | | soundPath | string | 是 | 文件绝对路径 | | duration | number | 是 | 录音时长 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createTextAtMessage.mdx b/docs/sdks/api/message/createTextAtMessage.mdx index 1fdf68b3f9..b6e2dc7c33 100644 --- a/docs/sdks/api/message/createTextAtMessage.mdx +++ b/docs/sdks/api/message/createTextAtMessage.mdx @@ -310,7 +310,7 @@ OpenIMSDKRN.createTextAtMessage({ atUserIDList: string[], atUsersInfo: AtUsersInfoItem[]; message?: MessageItem; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -321,14 +321,14 @@ OpenIMSDKRN.createTextAtMessage({ | atUserIDList | string[] | 是 | @人的 userID 列表 | | atUsersInfo | [AtUsersInfoItem](docs/sdks/class/message/atInfo.mdx)[] | 是 | @人的用户信息列表 | | message | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 是 | 引用的消息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createTextMessage.mdx b/docs/sdks/api/message/createTextMessage.mdx index 06717d6c7b..fd4d4261d1 100644 --- a/docs/sdks/api/message/createTextMessage.mdx +++ b/docs/sdks/api/message/createTextMessage.mdx @@ -210,7 +210,7 @@ IMSDK.asyncApi('createTextMessage', IMSDK.uuid(), 'text') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createTextMessage(textMsg: string,operationID: string): Promise +OpenIMSDKRN.createTextMessage(textMsg: string, operationID?: string): Promise ``` ### 输入参数 @@ -218,14 +218,14 @@ OpenIMSDKRN.createTextMessage(textMsg: string,operationID: string): Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createVideoMessageByURL.mdx b/docs/sdks/api/message/createVideoMessageByURL.mdx index 17c70c36b4..1a4a8434c9 100644 --- a/docs/sdks/api/message/createVideoMessageByURL.mdx +++ b/docs/sdks/api/message/createVideoMessageByURL.mdx @@ -317,7 +317,7 @@ OpenIMSDKRN.createVideoMessageByURL({ snapshotWidth: number, snapshotHeight: number, snapShotType: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -337,14 +337,14 @@ OpenIMSDKRN.createVideoMessageByURL({ | snapshotWidth | number | 是 | 视频缩略图宽度 | | snapshotHeight | number | 是 | 视频缩略图高度 | | snapShotType | string | 是 | 视频缩略图类型，一般为后缀名 | | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/createVideoMessageFromFullPath.mdx b/docs/sdks/api/message/createVideoMessageFromFullPath.mdx index fd4dda83aa..0774d09269 100644 --- a/docs/sdks/api/message/createVideoMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createVideoMessageFromFullPath.mdx @@ -256,7 +256,7 @@ OpenIMSDKRN.createVideoMessageFromFullPath({ videoType: string, duration: number, snapshotPath: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -267,14 +267,14 @@ OpenIMSDKRN.createVideoMessageFromFullPath({ | videoType | string | 是 | 视频类型，一般为后缀名 | | duration | number | 是 | 时长 | | snapshotPath | string | 是 | 视频封面绝对路径 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------- | ------------ | | Promise.then() | Promise<[MessageItem](docs/sdks/class/message/messageInfo.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/deleteAllMsgFromLocal.mdx b/docs/sdks/api/message/deleteAllMsgFromLocal.mdx index b1f23ce20b..fa83b42a75 100644 --- a/docs/sdks/api/message/deleteAllMsgFromLocal.mdx +++ b/docs/sdks/api/message/deleteAllMsgFromLocal.mdx @@ -215,21 +215,21 @@ IMSDK.asyncApi('deleteAllMsgFromLocal', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteAllMsgFromLocal(operationID: string): Promise +OpenIMSDKRN.deleteAllMsgFromLocal(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx b/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx index 6c0c409fff..e387371268 100644 --- a/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx +++ b/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx @@ -218,21 +218,21 @@ IMSDK.asyncApi('deleteAllMsgFromLocalAndSvr', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteAllMsgFromLocalAndSvr(operationID: string): Promise +OpenIMSDKRN.deleteAllMsgFromLocalAndSvr(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/deleteMessage.mdx b/docs/sdks/api/message/deleteMessage.mdx index 1016818ce1..cb7b8771f6 100644 --- a/docs/sdks/api/message/deleteMessage.mdx +++ b/docs/sdks/api/message/deleteMessage.mdx @@ -262,14 +262,14 @@ IMSDK.asyncApi('deleteMessage', IMSDK.uuid(), { OpenIMSDKRN.deleteMessage({ conversationID: string, clientMsgID:string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | | clientMsgID | string | 是 | 消息 ID | @@ -278,7 +278,7 @@ OpenIMSDKRN.deleteMessage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx b/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx index 787434174e..df8304215d 100644 --- a/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx +++ b/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx @@ -252,14 +252,14 @@ IMSDK.asyncApi('deleteMessageFromLocalStorage', IMSDK.uuid(), { OpenIMSDKRN.deleteMessageFromLocalStorage({ conversationID: string, clientMsgID:string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | | clientMsgID | string | 是 | 消息 ID | @@ -268,7 +268,7 @@ OpenIMSDKRN.deleteMessageFromLocalStorage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/findMessageList.mdx b/docs/sdks/api/message/findMessageList.mdx index 9800d53db2..5060c3ebfd 100644 --- a/docs/sdks/api/message/findMessageList.mdx +++ b/docs/sdks/api/message/findMessageList.mdx @@ -291,7 +291,7 @@ IMSDK.asyncApi('findMessageList', IMSDK.uuid(), { OpenIMSDKRN.findMessageList({ conversationID: string, clientMsgIDList: string[] -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -300,14 +300,14 @@ OpenIMSDKRN.findMessageList({ | --------------- | -------- | -------- | ------------------------------------------------------- | | conversationID | string | 是 | 会话 ID | | clientMsgIDList | string[] | 是 | 消息 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx index d156d1cf91..33eaaa5445 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx @@ -279,7 +279,7 @@ OpenIMSDKRN.getAdvancedHistoryMessageList({ count: number; startClientMsgID: string; conversationID: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -290,14 +290,14 @@ OpenIMSDKRN.getAdvancedHistoryMessageList({ | startClientMsgID | string | 是 | 起始的消息 clientMsgID，第一次拉取为""，后续为上一次拉取的最后一条消息的 clientMsgID | | count | number | 是 | 一次拉取的数量 | | lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值，上下文，第二次拉取需要回传 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[AdvancedGetMessageResult](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx index 6a8c62a499..c86b133093 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -272,7 +272,7 @@ OpenIMSDKRN.getAdvancedHistoryMessageListReverse({ count: number; startClientMsgID: string; conversationID: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -283,14 +283,14 @@ OpenIMSDKRN.getAdvancedHistoryMessageListReverse({ | startClientMsgID | string | 是 | 起始的消息 clientMsgID，第一次拉取为""，后续为上一次拉取的最后一条消息的 clientMsgID | | count | number | 是 | 一次拉取的数量 | | lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值，上下文，第二次拉取需要回传 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------------------------ | ------------ | | Promise.then() | Promise<[AdvancedGetMessageResult](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx b/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx index 3183e27ea5..b299ec05bf 100644 --- a/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx +++ b/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx @@ -275,14 +275,14 @@ OpenIMSDKRN.insertGroupMessageToLocalStorage({ message: MessageItem; groupID: string; sendID: string; -},operationID: string): Promise +},operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | message | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 是 | 消息体 | | groupID | string | 是 | 接收消息的 groupID | | sendID | string | 是 | 发送消息的 userID | @@ -292,7 +292,7 @@ OpenIMSDKRN.insertGroupMessageToLocalStorage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx b/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx index 18302f600c..b149698247 100644 --- a/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx +++ b/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx @@ -277,14 +277,14 @@ OpenIMSDKRN.insertSingleMessageToLocalStorage({ message: MessageItem; recvID: string; sendID: string; -},operationID: string): Promise +},operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | message | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 是 | 消息体 | | recvID | string | 是 | 接收消息的 groupID | | sendID | string | 是 | 发送消息的 userID | @@ -294,7 +294,7 @@ OpenIMSDKRN.insertSingleMessageToLocalStorage({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/revokeMessage.mdx b/docs/sdks/api/message/revokeMessage.mdx index 4f20b66a1c..51bcf6eb9b 100644 --- a/docs/sdks/api/message/revokeMessage.mdx +++ b/docs/sdks/api/message/revokeMessage.mdx @@ -261,7 +261,7 @@ IMSDK.asyncApi('revokeMessage', IMSDK.uuid(), { OpenIMSDKRN.revokeMessage({ conversationID: string, clientMsgID: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -270,14 +270,14 @@ OpenIMSDKRN.revokeMessage({ | -------------- | -------- | -------- | ------------------------------------------------------- | | conversationID | string | 是 | 会话 ID | | clientMsgID | string | 是 | 消息 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/searchLocalMessages.mdx b/docs/sdks/api/message/searchLocalMessages.mdx index de15f52da1..591357e1d0 100644 --- a/docs/sdks/api/message/searchLocalMessages.mdx +++ b/docs/sdks/api/message/searchLocalMessages.mdx @@ -371,14 +371,14 @@ OpenIMSDKRN.searchLocalMessages( { searchTimePeriod: number, pageIndex: number, count: number, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------------- | ------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 否 | 根据会话查询，如果是全局搜索传空字符串即可 | | keywordList | string[] | 是 | 搜索关键词列表，目前仅支持一个关键词搜索 | | keywordListMatchType | number | 否 | 关键词匹配模式，1 代表与，2 代表或，暂时未用 | @@ -394,7 +394,7 @@ OpenIMSDKRN.searchLocalMessages( { | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/sendMessage.mdx b/docs/sdks/api/message/sendMessage.mdx index 0570988cef..19e9467f09 100644 --- a/docs/sdks/api/message/sendMessage.mdx +++ b/docs/sdks/api/message/sendMessage.mdx @@ -308,7 +308,7 @@ OpenIMSDKRN.sendMessage({ groupID: string, offlinePushInfo?: OfflinePush, message: MessageItem, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -319,14 +319,14 @@ OpenIMSDKRN.sendMessage({ | recvID | string | 是 | 接收消息的 user ID，发送群消息时传空字符串 | | groupID | string | 是 | 接收消息的 group ID，发送单聊消息时传空字符串 | | offlinePushInfo | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 是 | 离线消息体 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/sendMessageNotOss.mdx b/docs/sdks/api/message/sendMessageNotOss.mdx index 33580dfbfd..85524be5c6 100644 --- a/docs/sdks/api/message/sendMessageNotOss.mdx +++ b/docs/sdks/api/message/sendMessageNotOss.mdx @@ -309,7 +309,7 @@ OpenIMSDKRN.sendMessageNotOss({ groupID: string; offlinePushInfo?: OfflinePush; message: MessageItem; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -320,14 +320,14 @@ OpenIMSDKRN.sendMessageNotOss({ | recvID | string | 是 | 接收消息的 user ID，发送群消息时传空字符串 | | groupID | string | 是 | 接收消息的 group ID，发送单聊消息时传空字符串 | | offlinePushInfo | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 是 | 离线消息体 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/setMessageLocalEx.mdx b/docs/sdks/api/message/setMessageLocalEx.mdx index 2077bceebe..057e4da429 100644 --- a/docs/sdks/api/message/setMessageLocalEx.mdx +++ b/docs/sdks/api/message/setMessageLocalEx.mdx @@ -258,14 +258,14 @@ OpenIMSDKRN.setMessageLocalEx( { conversationID: string; clientMsgID: string; localEx: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | conversationID | string | 是 | 会话 ID | | clientMsgID | string | 是 | 消息 ID | | localEx | string | 是 | 要设置的 ex 信息 | @@ -275,7 +275,7 @@ OpenIMSDKRN.setMessageLocalEx( { | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/message/typingStatusUpdate.mdx b/docs/sdks/api/message/typingStatusUpdate.mdx index 2b3097c91e..d23a82793f 100644 --- a/docs/sdks/api/message/typingStatusUpdate.mdx +++ b/docs/sdks/api/message/typingStatusUpdate.mdx @@ -253,7 +253,7 @@ IMSDK.asyncApi('typingStatusUpdate', IMSDK.uuid(), { OpenIMSDKRN.typingStatusUpdate({ recvID: string, msgTip: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -262,14 +262,14 @@ OpenIMSDKRN.typingStatusUpdate({ | ----------- | -------- | -------- | ------------------------------------------------------- | | recvID | string | 是 | 接收者 ID | | msgTip | string | 是 | 自定义内容提示 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/acceptFriendApplication.mdx b/docs/sdks/api/relation/acceptFriendApplication.mdx index 37135d4b59..60bcfe9c3f 100644 --- a/docs/sdks/api/relation/acceptFriendApplication.mdx +++ b/docs/sdks/api/relation/acceptFriendApplication.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('acceptFriendApplication', IMSDK.uuid(), { OpenIMSDKRN.acceptFriendApplication({ toUserID: string; handleMsg: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -259,14 +259,14 @@ OpenIMSDKRN.acceptFriendApplication({ | ----------- | -------- | -------- | ------------------------------------------------------- | | toUserID | string | 是 | 申请发起者用户 ID | | handleMsg | string | 是 | 操作信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/addBlack.mdx b/docs/sdks/api/relation/addBlack.mdx index 9b752902e1..b71ed5603e 100644 --- a/docs/sdks/api/relation/addBlack.mdx +++ b/docs/sdks/api/relation/addBlack.mdx @@ -235,7 +235,7 @@ IMSDK.asyncApi('addBlack', IMSDK.uuid(), { toUserID: 'userID' }) OpenIMSDKRN.addBlack({ toUserID: string; ex?: string; -}, operationID: string): Promise; +}, operationID?: string): Promise; ``` ### 输入参数 @@ -244,14 +244,14 @@ OpenIMSDKRN.addBlack({ | ----------- | -------- | -------- | ------------------------------------------------------- | | userID | string | 是 | 用户 ID | | ex | string | 否 | 扩展字段 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/addFriend.mdx b/docs/sdks/api/relation/addFriend.mdx index 5de07e34ff..b353e5eef5 100644 --- a/docs/sdks/api/relation/addFriend.mdx +++ b/docs/sdks/api/relation/addFriend.mdx @@ -255,14 +255,14 @@ OpenIMSDKRN.addFriend({ | ----------- | -------- | -------- | ------------------------------------------------------- | | toUserID | string | 是 | 要添加的用户 ID | | reqMsg | string | 是 | 好友请求信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/checkFriend.mdx b/docs/sdks/api/relation/checkFriend.mdx index 96d531ca7d..1b63a2039f 100644 --- a/docs/sdks/api/relation/checkFriend.mdx +++ b/docs/sdks/api/relation/checkFriend.mdx @@ -257,7 +257,7 @@ type FriendshipInfo = { result: number; // 1是好友 0非好友 userID: string; }; -OpenIMSDKRN.checkFriend(userIDList: string[], operationID: string): Promise +OpenIMSDKRN.checkFriend(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -265,7 +265,7 @@ OpenIMSDKRN.checkFriend(userIDList: string[], operationID: string): Promise | 好友关系结果信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/deleteFriend.mdx b/docs/sdks/api/relation/deleteFriend.mdx index 19f0979fbf..4a79022e53 100644 --- a/docs/sdks/api/relation/deleteFriend.mdx +++ b/docs/sdks/api/relation/deleteFriend.mdx @@ -224,7 +224,7 @@ IMSDK.asyncApi('deleteFriend', IMSDK.uuid(), 'userID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteFriend(userID: string, operationID: string): Promise; +OpenIMSDKRN.deleteFriend(userID: string, operationID?: string): Promise; ``` ### 输入参数 @@ -232,14 +232,14 @@ OpenIMSDKRN.deleteFriend(userID: string, operationID: string): Promise; | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | userID | string | 是 | 用户 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getBlackList.mdx b/docs/sdks/api/relation/getBlackList.mdx index db5ccaac17..2834e38947 100644 --- a/docs/sdks/api/relation/getBlackList.mdx +++ b/docs/sdks/api/relation/getBlackList.mdx @@ -204,21 +204,21 @@ IMSDK.asyncApi('getBlackList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getBlackList(operationID: string): Promise +OpenIMSDKRN.getBlackList(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ----------------------------------------------------------------- | ------------------ | | Promise.then() | Promise<[BlackUserItem](docs/sdks/class/relation/blackInfo.mdx)[]\> | 黑名单信息对象列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx b/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx index fcce110f4c..9893b06c2e 100644 --- a/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx +++ b/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx @@ -220,21 +220,26 @@ IMSDK.asyncApi('getFriendApplicationListAsApplicant', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendApplicationListAsApplicant(operationID: string): Promise +OpenIMSDKRN.getFriendApplicationListAsApplicant(req: { + offset: number; + count: number; +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| offset | number | 是 | 分页拉取起始下标 | +| count | number | 是 | 一页拉取的数量 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | --------------------------------------------------------------------------------- | ------------------ | | Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 发出的好友请求列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx b/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx index 1abd5a13f6..601c4f6620 100644 --- a/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx +++ b/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx @@ -220,21 +220,28 @@ IMSDK.asyncApi('getFriendApplicationListAsRecipient', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendApplicationListAsRecipient(operationID: string): Promise +OpenIMSDKRN.getFriendApplicationListAsRecipient(req: { + offset: number; + count: number; + handleResults: number[] +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| offset | number | 是 | 分页拉取起始下标 | +| count | number | 是 | 一页拉取的数量 | +| handleResults | number[] | 是 | - | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | --------------------------------------------------------------------------------- | ------------------ | | Promise.then() | Promise<[FriendApplicationItem](docs/sdks/class/relation/friendApplication.mdx)[]\> | 收到的好友请求列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getFriendList.mdx b/docs/sdks/api/relation/getFriendList.mdx index bc8f5ab89e..d49a9d14bb 100644 --- a/docs/sdks/api/relation/getFriendList.mdx +++ b/docs/sdks/api/relation/getFriendList.mdx @@ -196,7 +196,7 @@ IMSDK.asyncApi('getFriendList', operationID: string, filterBlack: boolean): Prom | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------- | ---------------- | | Promise.then() | Promise<[FriendUserItem](docs/sdks/class/relation/friendInfo.mdx)[]\> | 好友信息对象列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 @@ -218,7 +218,7 @@ IMSDK.asyncApi('getFriendList', IMSDK.uuid(), false) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID: string): Promise +OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID?: string): Promise ``` ### 输入参数 @@ -226,14 +226,14 @@ OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID: string): Promise | 好友信息对象列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getFriendListPage.mdx b/docs/sdks/api/relation/getFriendListPage.mdx index a68834bc44..c4341ff678 100644 --- a/docs/sdks/api/relation/getFriendListPage.mdx +++ b/docs/sdks/api/relation/getFriendListPage.mdx @@ -258,7 +258,7 @@ OpenIMSDKRN.getFriendListPage({ offset: number; count: number; filterBlack?: boolean; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -268,14 +268,14 @@ OpenIMSDKRN.getFriendListPage({ | offset | number | 是 | 分页拉取起始下标 | | count | number | 是 | 一页拉取的数量 | | filterBlack | boolean | 否 | 是否过滤掉黑名单 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------- | ---------------- | | Promise.then() | Promise\> | 好友信息对象列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx index a4888f4e97..0d808dbad2 100644 --- a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx +++ b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx @@ -242,7 +242,7 @@ IMSDK.asyncApi('getSpecifiedFriendsInfo', IMSDK.uuid(), { OpenIMSDKRN.getSpecifiedFriendsInfo({ friendUserIDList: string[]; filterBlack?: boolean; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -251,14 +251,14 @@ OpenIMSDKRN.getSpecifiedFriendsInfo({ | ---------- | -------- | -------- | ------------ | | friendUserIDList | string[] | 是 | 用户 ID 列表 | | filterBlack | boolean | 否 | 是否过滤掉黑名单 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------------------- | ------------ | | Promise.then() | Promise\> | 好友信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/refuseFriendApplication.mdx b/docs/sdks/api/relation/refuseFriendApplication.mdx index 93252ff5c0..f3d1f4e570 100644 --- a/docs/sdks/api/relation/refuseFriendApplication.mdx +++ b/docs/sdks/api/relation/refuseFriendApplication.mdx @@ -249,7 +249,7 @@ IMSDK.asyncApi('refuseFriendApplication', IMSDK.uuid(), { OpenIMSDKRN.refuseFriendApplication({ toUserID: string; handleMsg: string; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -258,14 +258,14 @@ OpenIMSDKRN.refuseFriendApplication({ | --------- | -------- | -------- | ----------------- | | toUserID | string | 是 | 申请发起者用户 ID | | handleMsg | string | 是 | 操作信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/removeBlack.mdx b/docs/sdks/api/relation/removeBlack.mdx index c8eeeb4479..e33b28c05d 100644 --- a/docs/sdks/api/relation/removeBlack.mdx +++ b/docs/sdks/api/relation/removeBlack.mdx @@ -225,7 +225,7 @@ IMSDK.asyncApi('removeBlack', IMSDK.uuid(), 'userID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.removeBlack(userID: string, operationID: string): Promise +OpenIMSDKRN.removeBlack(userID: string, operationID?: string): Promise ``` ### 输入参数 @@ -233,14 +233,14 @@ OpenIMSDKRN.removeBlack(userID: string, operationID: string): Promise | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | userID | string | 是 | 用户 ID | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/searchFriends.mdx b/docs/sdks/api/relation/searchFriends.mdx index 0990c48430..91544847fb 100644 --- a/docs/sdks/api/relation/searchFriends.mdx +++ b/docs/sdks/api/relation/searchFriends.mdx @@ -331,7 +331,7 @@ OpenIMSDKRN.searchFriends({ isSearchUserID: boolean; isSearchNickname: boolean; isSearchRemark: boolean; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -342,7 +342,7 @@ OpenIMSDKRN.searchFriends({ | isSearchUserID | boolean | 是 | 是否以关键词搜索 userID | | isSearchNickname | boolean | 是 | 是否以关键词搜索昵称 | | isSearchRemark | boolean | 是 | 是否以关键词搜索备注 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 @@ -350,7 +350,7 @@ OpenIMSDKRN.searchFriends({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | -------------------- | | Promise.then() | Promise | 搜索到的好友信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/relation/updateFriends.mdx b/docs/sdks/api/relation/updateFriends.mdx index 97c3c8cb76..bbf4f7f420 100644 --- a/docs/sdks/api/relation/updateFriends.mdx +++ b/docs/sdks/api/relation/updateFriends.mdx @@ -255,14 +255,14 @@ OpenIMSDKRN.updateFriends({ isPinned?: boolean; remark?: boolean; ex?: boolean; -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | | friendUserIDs | string[] | 是 | 好友 ID 列表 | | isPinned | boolean | 否 | 是否为星标好友 | | remark | string | 否 | 好友备注 | @@ -274,7 +274,7 @@ OpenIMSDKRN.updateFriends({ | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/third/logs.mdx b/docs/sdks/api/third/logs.mdx index fa91c9b967..270a4daba9 100644 --- a/docs/sdks/api/third/logs.mdx +++ b/docs/sdks/api/third/logs.mdx @@ -279,7 +279,7 @@ OpenIMSDKRN.logs({ msgs: string, err: string, keyAndValue: string -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -292,14 +292,14 @@ OpenIMSDKRN.logs({ | msgs | string | 否 | 错误信息 | | err | string | 否 | 错误信息 | | keyAndValues | string | 否 | 参数 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ----------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/third/setAppBadge.mdx b/docs/sdks/api/third/setAppBadge.mdx index 1c99a778b5..3a7ef03e21 100644 --- a/docs/sdks/api/third/setAppBadge.mdx +++ b/docs/sdks/api/third/setAppBadge.mdx @@ -157,7 +157,7 @@ IMSDK.asyncApi('setAppBadge', IMSDK.uuid(), 99) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID: string): Promise +OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID?: string): Promise ``` ### 输入参数 @@ -165,14 +165,14 @@ OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID: string): Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/third/updateFcmToken.mdx b/docs/sdks/api/third/updateFcmToken.mdx index 97b27a718c..eb173c275c 100644 --- a/docs/sdks/api/third/updateFcmToken.mdx +++ b/docs/sdks/api/third/updateFcmToken.mdx @@ -193,10 +193,8 @@ updateFcmToken(fcmToken, expireTime) ### Function Prototype -```javascript showLineNumbers -function updateFcmToken(fcmToken, expireTime) { - // implementation -} +```ts showLineNumbers +OpenIMSDKRN.updateFcmToken(fcmToken: string, expireTime: number, operationID?: string): Promise; ``` ### Input Parameters @@ -205,10 +203,11 @@ function updateFcmToken(fcmToken, expireTime) { | ----------------| ----------------------------| | fcmToken | FCM Token | | expireTime | FCM Token expiration time, in seconds | +| operationID | Operation ID, optional | ### Code Example -```javascript showLineNumbers +```ts showLineNumbers updateFcmToken(fcmToken, expireTime) .then(data => { // handle success diff --git a/docs/sdks/api/third/uploadFile.mdx b/docs/sdks/api/third/uploadFile.mdx index e360da45c7..ded6f12b00 100644 --- a/docs/sdks/api/third/uploadFile.mdx +++ b/docs/sdks/api/third/uploadFile.mdx @@ -321,7 +321,7 @@ OpenIMSDKRN.uploadFile({ contentType: string; uuid: string; filepath: string; -}, operationID: string): Promise<{ url: string }> +}, operationID?: string): Promise<{ url: string }> ``` ### 输入参数 @@ -332,14 +332,14 @@ OpenIMSDKRN.uploadFile({ | contentType | string | 是 | 文件类型 | | uuid | string | 是 | 文件唯一 ID | | filepath | string | 是 | 文件绝对路径 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise<{url:string}\> | 文件远程链接 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/third/uploadLogs.mdx b/docs/sdks/api/third/uploadLogs.mdx index b61a0c8d67..ef50c09cde 100644 --- a/docs/sdks/api/third/uploadLogs.mdx +++ b/docs/sdks/api/third/uploadLogs.mdx @@ -235,7 +235,7 @@ IMSDK.asyncApi('uploadLogs', IMSDK.uuid(), { line: 10000, ex: "" }) OpenIMSDKRN.uploadLogs({ line: number, ex: string, -}, operationID: string): Promise +}, operationID?: string): Promise ``` ### 输入参数 @@ -244,14 +244,14 @@ OpenIMSDKRN.uploadLogs({ | -------------- | -------- | -------- | ---------------- | | line | number | 是 | 从后往前上传的行数 | | | ex | string | 是 | 额外字段 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ----------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/getSelfUserInfo.mdx b/docs/sdks/api/user/getSelfUserInfo.mdx index 49e8135ae0..2b03d31701 100644 --- a/docs/sdks/api/user/getSelfUserInfo.mdx +++ b/docs/sdks/api/user/getSelfUserInfo.mdx @@ -205,22 +205,21 @@ IMSDK.asyncApi('getSelfUserInfo', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSelfUserInfo(operationID: string): Promise +OpenIMSDKRN.getSelfUserInfo(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ----------------------------------------------------------- | ------------ | | Promise.then() | Promise<[SelfUserInfo](docs/sdks/class/user/userInfo.mdx)\> | 个人信息对象 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/getSubscribeUsersStatus.mdx b/docs/sdks/api/user/getSubscribeUsersStatus.mdx index bb7dec9ab9..9724839ff5 100644 --- a/docs/sdks/api/user/getSubscribeUsersStatus.mdx +++ b/docs/sdks/api/user/getSubscribeUsersStatus.mdx @@ -224,21 +224,21 @@ IMSDK.asyncApi('getSubscribeUsersStatus', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSubscribeUsersStatus(operationID: string): Promise +OpenIMSDKRN.getSubscribeUsersStatus(operationID?: string): Promise ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------- | -------------------- | | Promise.then() | Promise<[UserOnlineState](docs/sdks/class/user/userStatusInfo.mdx)[]\> | 用户在线状态详情列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/getUsersInfo.mdx b/docs/sdks/api/user/getUsersInfo.mdx index 3846421af7..2fcafe6197 100644 --- a/docs/sdks/api/user/getUsersInfo.mdx +++ b/docs/sdks/api/user/getUsersInfo.mdx @@ -231,7 +231,7 @@ IMSDK.asyncApi('getUsersInfo', IMSDK.uuid(), userIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getUsersInfo(userIDList: string[], operationID: string): Promise +OpenIMSDKRN.getUsersInfo(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -239,14 +239,14 @@ OpenIMSDKRN.getUsersInfo(userIDList: string[], operationID: string): Promise | 查询到的用户信息列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/setSelfInfo.mdx b/docs/sdks/api/user/setSelfInfo.mdx index 898d9e6174..531a3bea3f 100644 --- a/docs/sdks/api/user/setSelfInfo.mdx +++ b/docs/sdks/api/user/setSelfInfo.mdx @@ -262,8 +262,8 @@ IMSDK.asyncApi('setSelfInfo', IMSDK.uuid(), userInfo) ```ts showLineNumbers OpenIMSDKRN.setSelfInfo( - userInfo: Partial>, - operationID: string + userInfo: Partial, + operationID?: string ): Promise ``` @@ -271,15 +271,15 @@ OpenIMSDKRN.setSelfInfo( | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------------------------------------------------------------------------- | -------- | ------------------------------------------------------- | -| userInfo | Partial> | 是 | 个人信息 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| userInfo | Partial<[SelfUserInfo](docs/sdks/class/user/userInfo.mdx)> | 是 | 个人信息 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/subscribeUsersStatus.mdx b/docs/sdks/api/user/subscribeUsersStatus.mdx index 79531741f2..89b92e9e2e 100644 --- a/docs/sdks/api/user/subscribeUsersStatus.mdx +++ b/docs/sdks/api/user/subscribeUsersStatus.mdx @@ -237,7 +237,7 @@ IMSDK.asyncApi('subscribeUsersStatus', IMSDK.uuid(), userIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID: string): Promise +OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -245,14 +245,14 @@ OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID: string): Pro | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | userIDList | string[] | 是 | 用户 ID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------- | -------------------- | | Promise.then() | Promise<[UserOnlineState](docs/sdks/class/user/userStatusInfo.mdx)[]\> | 用户在线状态详情列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 diff --git a/docs/sdks/api/user/unsubscribeUsersStatus.mdx b/docs/sdks/api/user/unsubscribeUsersStatus.mdx index 9735a4fb65..97fb0202ad 100644 --- a/docs/sdks/api/user/unsubscribeUsersStatus.mdx +++ b/docs/sdks/api/user/unsubscribeUsersStatus.mdx @@ -230,7 +230,7 @@ IMSDK.asyncApi('unsubscribeUsersStatus', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID: string): Promise +OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -238,14 +238,14 @@ OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID: string): P | 参数名称 | 参数类型 | 是否必填 | 描述 | | ----------- | -------- | -------- | ------------------------------------------------------- | | userIDList | string[] | 是 | 用户 ID 列表 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | +| operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 | 参数名称 | 参数类型 | 描述 | | --------------- | ---------------------------------------------------------------------- | -------------------- | | Promise.then() | Promise<[UserOnlineState](docs/sdks/class/user/userStatusInfo.mdx)[]\> | 用户在线状态详情列表 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | +| Promise.catch() | Promise<[OpenIMApiError](docs/sdks/class/response.mdx)\> | 调用失败回调 | ### 代码示例 From d82f7db4914eee9356c69cfaf82047c3cfc39047 Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 17:28:15 +0800 Subject: [PATCH 4/6] feat(rn-sdk): add logFilePath parameter to InitConfig --- docs/sdks/class/init/config.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sdks/class/init/config.mdx b/docs/sdks/class/init/config.mdx index c2441d8a75..c20e96a8c1 100644 --- a/docs/sdks/class/init/config.mdx +++ b/docs/sdks/class/init/config.mdx @@ -130,7 +130,8 @@ values={[ | wsAddr | string | 是 | IM ws 地址，一般为`ws://xxx:10001`或`wss://xxx/msg_gateway` | | dataDir | string | 是 | IM 客户端 DB 存放目录 | | logLevel | [LogLevel](/docs/sdks/enum/logLevel.mdx) | 否 | SDK 日志打印级别 | -| isLogStandardOutput | boolean | 否 | 是否将日志打印到控制台 | +| isLogStandardOutput | boolean | 否 | 是否将日志打印到控制台 | +| logFilePath | string | 否 | 本地保存日志文件路径 | From b0fe6f7640468c3ff06e61ca9c863a402c2dfbeb Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 19:26:47 +0800 Subject: [PATCH 5/6] feat(rn-sdk): update code examples and function prototype --- docs/sdks/api/conversation/changeInputStates.mdx | 10 +++++----- .../clearConversationAndDeleteAllMsg.mdx | 8 ++++---- .../deleteConversationAndDeleteAllMsg.mdx | 8 ++++---- .../api/conversation/getAllConversationList.mdx | 8 ++++---- .../conversation/getConversationIDBySessionType.mdx | 10 +++++----- .../api/conversation/getConversationListSplit.mdx | 10 +++++----- docs/sdks/api/conversation/getInputStates.mdx | 10 +++++----- .../api/conversation/getMultipleConversation.mdx | 8 ++++---- docs/sdks/api/conversation/getOneConversation.mdx | 10 +++++----- .../api/conversation/getTotalUnreadMsgCount.mdx | 8 ++++---- docs/sdks/api/conversation/hideAllConversation.mdx | 8 ++++---- docs/sdks/api/conversation/hideConversation.mdx | 8 ++++---- .../conversation/markConversationMessageAsRead.mdx | 8 ++++---- docs/sdks/api/conversation/setConversation.mdx | 11 +++++------ docs/sdks/api/conversation/setConversationDraft.mdx | 10 +++++----- docs/sdks/api/group/acceptGroupApplication.mdx | 10 +++++----- docs/sdks/api/group/changeGroupMemberMute.mdx | 10 +++++----- docs/sdks/api/group/changeGroupMute.mdx | 10 +++++----- docs/sdks/api/group/createGroup.mdx | 10 +++++----- docs/sdks/api/group/dismissGroup.mdx | 8 ++++---- .../group/getGroupApplicationListAsApplicant.mdx | 13 +++++++++---- .../group/getGroupApplicationListAsRecipient.mdx | 13 +++++++++---- docs/sdks/api/group/getGroupMemberList.mdx | 10 +++++----- .../group/getGroupMemberListByJoinTimeFilter.mdx | 10 +++++----- docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx | 8 ++++---- docs/sdks/api/group/getJoinedGroupList.mdx | 8 ++++---- docs/sdks/api/group/getJoinedGroupListPage.mdx | 10 +++++----- .../sdks/api/group/getSpecifiedGroupMembersInfo.mdx | 10 +++++----- docs/sdks/api/group/getSpecifiedGroupsInfo.mdx | 8 ++++---- docs/sdks/api/group/getUsersInGroup.mdx | 10 +++++----- docs/sdks/api/group/inviteUserToGroup.mdx | 10 +++++----- docs/sdks/api/group/isJoinGroup.mdx | 8 ++++---- docs/sdks/api/group/joinGroup.mdx | 10 +++++----- docs/sdks/api/group/kickGroupMember.mdx | 10 +++++----- docs/sdks/api/group/quitGroup.mdx | 8 ++++---- docs/sdks/api/group/refuseGroupApplication.mdx | 10 +++++----- docs/sdks/api/group/searchGroupMembers.mdx | 10 +++++----- docs/sdks/api/group/searchGroups.mdx | 10 +++++----- docs/sdks/api/group/setGroupInfo.mdx | 11 +++++------ docs/sdks/api/group/setGroupMemberInfo.mdx | 10 +++++----- docs/sdks/api/group/transferGroupOwner.mdx | 10 +++++----- docs/sdks/api/initialization/getLoginStatus.mdx | 8 ++++---- docs/sdks/api/initialization/getLoginUserID.mdx | 9 ++++----- docs/sdks/api/initialization/initSDK.mdx | 9 +++++---- docs/sdks/api/initialization/login.mdx | 10 +++++----- docs/sdks/api/initialization/logout.mdx | 8 ++++---- docs/sdks/api/initialization/unInitSDK.mdx | 8 ++++---- docs/sdks/api/message/createCardMessage.mdx | 10 +++++----- docs/sdks/api/message/createCustomMessage.mdx | 10 +++++----- docs/sdks/api/message/createFaceMessage.mdx | 10 +++++----- docs/sdks/api/message/createFileMessageByURL.mdx | 10 +++++----- .../api/message/createFileMessageFromFullPath.mdx | 10 +++++----- docs/sdks/api/message/createForwardMessage.mdx | 8 ++++---- docs/sdks/api/message/createImageMessageByURL.mdx | 10 +++++----- .../api/message/createImageMessageFromFullPath.mdx | 8 ++++---- docs/sdks/api/message/createLocationMessage.mdx | 10 +++++----- docs/sdks/api/message/createMergeMessage.mdx | 8 ++++---- docs/sdks/api/message/createQuoteMessage.mdx | 10 +++++----- docs/sdks/api/message/createSoundMessageByURL.mdx | 10 +++++----- .../api/message/createSoundMessageFromFullPath.mdx | 10 +++++----- docs/sdks/api/message/createTextAtMessage.mdx | 10 +++++----- docs/sdks/api/message/createTextMessage.mdx | 8 ++++---- docs/sdks/api/message/createVideoMessageByURL.mdx | 10 +++++----- .../api/message/createVideoMessageFromFullPath.mdx | 10 +++++----- docs/sdks/api/message/deleteAllMsgFromLocal.mdx | 8 ++++---- .../api/message/deleteAllMsgFromLocalAndSvr.mdx | 8 ++++---- docs/sdks/api/message/deleteMessage.mdx | 10 +++++----- .../api/message/deleteMessageFromLocalStorage.mdx | 10 +++++----- docs/sdks/api/message/findMessageList.mdx | 9 ++++----- .../api/message/getAdvancedHistoryMessageList.mdx | 10 +++++----- .../getAdvancedHistoryMessageListReverse.mdx | 10 +++++----- .../message/insertGroupMessageToLocalStorage.mdx | 12 ++++++------ .../message/insertSingleMessageToLocalStorage.mdx | 12 ++++++------ docs/sdks/api/message/revokeMessage.mdx | 10 +++++----- docs/sdks/api/message/searchLocalMessages.mdx | 10 +++++----- docs/sdks/api/message/sendMessage.mdx | 10 +++++----- docs/sdks/api/message/sendMessageNotOss.mdx | 10 +++++----- docs/sdks/api/message/setMessageLocalEx.mdx | 10 +++++----- docs/sdks/api/message/typingStatusUpdate.mdx | 10 +++++----- docs/sdks/api/relation/acceptFriendApplication.mdx | 10 +++++----- docs/sdks/api/relation/addBlack.mdx | 10 +++++----- docs/sdks/api/relation/addFriend.mdx | 10 +++++----- docs/sdks/api/relation/checkFriend.mdx | 8 ++++---- docs/sdks/api/relation/deleteFriend.mdx | 8 ++++---- docs/sdks/api/relation/getBlackList.mdx | 8 ++++---- .../getFriendApplicationListAsApplicant.mdx | 11 +++++++---- .../getFriendApplicationListAsRecipient.mdx | 12 ++++++++---- docs/sdks/api/relation/getFriendList.mdx | 8 ++++---- docs/sdks/api/relation/getFriendListPage.mdx | 10 +++++----- docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx | 10 +++++----- docs/sdks/api/relation/refuseFriendApplication.mdx | 10 +++++----- docs/sdks/api/relation/removeBlack.mdx | 8 ++++---- docs/sdks/api/relation/searchFriends.mdx | 12 ++++++------ docs/sdks/api/relation/updateFriends.mdx | 10 +++++----- docs/sdks/api/third/logs.mdx | 11 ++++++----- docs/sdks/api/third/setAppBadge.mdx | 8 ++++---- docs/sdks/api/third/updateFcmToken.mdx | 8 +++++--- docs/sdks/api/third/uploadFile.mdx | 10 +++++----- docs/sdks/api/third/uploadLogs.mdx | 8 ++++---- docs/sdks/api/user/getSelfUserInfo.mdx | 8 ++++---- docs/sdks/api/user/getSubscribeUsersStatus.mdx | 8 ++++---- docs/sdks/api/user/getUsersInfo.mdx | 8 ++++---- docs/sdks/api/user/setSelfInfo.mdx | 8 ++++---- docs/sdks/api/user/subscribeUsersStatus.mdx | 8 ++++---- docs/sdks/api/user/unsubscribeUsersStatus.mdx | 8 ++++---- 105 files changed, 504 insertions(+), 487 deletions(-) diff --git a/docs/sdks/api/conversation/changeInputStates.mdx b/docs/sdks/api/conversation/changeInputStates.mdx index 6f967ca6fb..7a1bbf590c 100644 --- a/docs/sdks/api/conversation/changeInputStates.mdx +++ b/docs/sdks/api/conversation/changeInputStates.mdx @@ -249,7 +249,7 @@ IMSDK.asyncApi('changeInputStates', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.changeInputStates({ +OpenIMSDK.changeInputStates({ conversationID: string, focus: boolean, }, operationID?: string): Promise @@ -272,16 +272,16 @@ OpenIMSDKRN.changeInputStates({ ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx b/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx index 55378f04e0..e51286fc43 100644 --- a/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx +++ b/docs/sdks/api/conversation/clearConversationAndDeleteAllMsg.mdx @@ -229,7 +229,7 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise +OpenIMSDK.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise ``` ### 输入参数 @@ -248,13 +248,13 @@ OpenIMSDKRN.clearConversationAndDeleteAllMsg(conversationID: string, operationID ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx b/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx index 627c3756d1..86aad49f16 100644 --- a/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx +++ b/docs/sdks/api/conversation/deleteConversationAndDeleteAllMsg.mdx @@ -223,7 +223,7 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise +OpenIMSDK.deleteConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise ``` ### 输入参数 @@ -242,13 +242,13 @@ OpenIMSDKRN.deleteConversationAndDeleteAllMsg(conversationID: string, operationI ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getAllConversationList.mdx b/docs/sdks/api/conversation/getAllConversationList.mdx index a79de9b0f2..2afb4b2946 100644 --- a/docs/sdks/api/conversation/getAllConversationList.mdx +++ b/docs/sdks/api/conversation/getAllConversationList.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('getAllConversationList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getAllConversationList(operationID?: string): Promise +OpenIMSDK.getAllConversationList(operationID?: string): Promise ``` ### 输入参数 @@ -237,13 +237,13 @@ OpenIMSDKRN.getAllConversationList(operationID?: string): Promise { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getConversationIDBySessionType.mdx b/docs/sdks/api/conversation/getConversationIDBySessionType.mdx index 942732eb65..5d1e9e0e20 100644 --- a/docs/sdks/api/conversation/getConversationIDBySessionType.mdx +++ b/docs/sdks/api/conversation/getConversationIDBySessionType.mdx @@ -227,7 +227,7 @@ IMSDK.asyncApi('getConversationIDBySessionType', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getConversationIDBySessionType({ +OpenIMSDK.getConversationIDBySessionType({ sourceID: string, sessionType: number, }, operationID?: string): Promise @@ -252,16 +252,16 @@ OpenIMSDKRN.getConversationIDBySessionType({ ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getConversationListSplit.mdx b/docs/sdks/api/conversation/getConversationListSplit.mdx index 869ec643ed..eade3cab33 100644 --- a/docs/sdks/api/conversation/getConversationListSplit.mdx +++ b/docs/sdks/api/conversation/getConversationListSplit.mdx @@ -245,7 +245,7 @@ IMSDK.asyncApi('getConversationListSplit', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getConversationListSplit({ +OpenIMSDK.getConversationListSplit({ offset: number, count: number, }, operationID?: string): Promise @@ -270,16 +270,16 @@ OpenIMSDKRN.getConversationListSplit({ ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getInputStates.mdx b/docs/sdks/api/conversation/getInputStates.mdx index cd10ef41ce..02926c06d0 100644 --- a/docs/sdks/api/conversation/getInputStates.mdx +++ b/docs/sdks/api/conversation/getInputStates.mdx @@ -247,7 +247,7 @@ IMSDK.asyncApi('getInputstates', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getInputstates({ +OpenIMSDK.getInputstates({ conversationID: string, userID: string, }, operationID?: string): Promise @@ -270,16 +270,16 @@ OpenIMSDKRN.getInputstates({ ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getMultipleConversation.mdx b/docs/sdks/api/conversation/getMultipleConversation.mdx index 485146bfb6..0f31db4a50 100644 --- a/docs/sdks/api/conversation/getMultipleConversation.mdx +++ b/docs/sdks/api/conversation/getMultipleConversation.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('getMultipleConversation', IMSDK.uuid(), ['conversationID']) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getMultipleConversation({ +OpenIMSDK.getMultipleConversation({ conversationIDList: string[], }, operationID?: string): Promise ``` @@ -240,13 +240,13 @@ OpenIMSDKRN.getMultipleConversation({ ### 代码示例 ```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) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getOneConversation.mdx b/docs/sdks/api/conversation/getOneConversation.mdx index 6e476b27d0..1b37f84660 100644 --- a/docs/sdks/api/conversation/getOneConversation.mdx +++ b/docs/sdks/api/conversation/getOneConversation.mdx @@ -240,7 +240,7 @@ IMSDK.asyncApi('getOneConversation', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getOneConversation({ +OpenIMSDK.getOneConversation({ sessionType: number, sourceID: string, }, operationID?: string): Promise @@ -264,16 +264,16 @@ OpenIMSDKRN.getOneConversation({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; - OpenIMSDKRN.getOneConversation({ + OpenIMSDK.getOneConversation({ sourceID: 'user1', sessionType: 1, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx b/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx index 89a83d1daf..14939cca6f 100644 --- a/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx +++ b/docs/sdks/api/conversation/getTotalUnreadMsgCount.mdx @@ -211,7 +211,7 @@ IMSDK.asyncApi('getTotalUnreadMsgCount', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getTotalUnreadMsgCount(operationID?: string): Promise +OpenIMSDK.getTotalUnreadMsgCount(operationID?: string): Promise ``` ### 输入参数 @@ -230,13 +230,13 @@ OpenIMSDKRN.getTotalUnreadMsgCount(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getTotalUnreadMsgCount('operationID') +OpenIMSDK.getTotalUnreadMsgCount() .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/hideAllConversation.mdx b/docs/sdks/api/conversation/hideAllConversation.mdx index 98f3f615ef..08aff487b5 100644 --- a/docs/sdks/api/conversation/hideAllConversation.mdx +++ b/docs/sdks/api/conversation/hideAllConversation.mdx @@ -171,7 +171,7 @@ IMSDK.deleteAllConversationFromLocal() ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.hideAllConversations(operationID?: string): Promise +OpenIMSDK.hideAllConversations(operationID?: string): Promise ``` ### 输入参数 @@ -190,13 +190,13 @@ OpenIMSDKRN.hideAllConversations(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.hideAllConversations('operationID') +OpenIMSDK.hideAllConversations() .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/hideConversation.mdx b/docs/sdks/api/conversation/hideConversation.mdx index 8cd7ac6dad..528e1f543d 100644 --- a/docs/sdks/api/conversation/hideConversation.mdx +++ b/docs/sdks/api/conversation/hideConversation.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('hideConversation', IMSDK.uuid(), 'conversationID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.hideConversation(conversationID: string, operationID?: string): Promise +OpenIMSDK.hideConversation(conversationID: string, operationID?: string): Promise ``` ### 输入参数 @@ -238,13 +238,13 @@ OpenIMSDKRN.hideConversation(conversationID: string, operationID?: string): Prom ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.hideConversation('conversationID', 'operationID') +OpenIMSDK.hideConversation('conversationID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx index 73f8e44e25..e42e5be1f9 100644 --- a/docs/sdks/api/conversation/markConversationMessageAsRead.mdx +++ b/docs/sdks/api/conversation/markConversationMessageAsRead.mdx @@ -233,7 +233,7 @@ IMSDK.asyncApi('markConversationMessageAsRead', IMSDK.uuid(), 'conversationID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.markConversationMessageAsRead(conversationID: string, operationID?: string): Promise +OpenIMSDK.markConversationMessageAsRead(conversationID: string, operationID?: string): Promise ``` ### 输入参数 @@ -253,13 +253,13 @@ OpenIMSDKRN.markConversationMessageAsRead(conversationID: string, operationID?: ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.markConversationMessageAsRead('conversationID', 'operationID') +OpenIMSDK.markConversationMessageAsRead('conversationID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/setConversation.mdx b/docs/sdks/api/conversation/setConversation.mdx index 13ed7bc7d2..c02523aa85 100644 --- a/docs/sdks/api/conversation/setConversation.mdx +++ b/docs/sdks/api/conversation/setConversation.mdx @@ -268,7 +268,7 @@ IMSDK.asyncApi('setConversation', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setConversation({ +OpenIMSDK.setConversation({ conversationID: string; recvMsgOpt?: MessageReceiveOptType; groupAtType?: GroupAtType; @@ -301,19 +301,18 @@ OpenIMSDKRN.setConversation({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.setConversation( +OpenIMSDK.setConversation( { conversationID: '', isPinned: true, - }, - 'operationID' + } ) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/conversation/setConversationDraft.mdx b/docs/sdks/api/conversation/setConversationDraft.mdx index 79bb508c1d..8c681a9341 100644 --- a/docs/sdks/api/conversation/setConversationDraft.mdx +++ b/docs/sdks/api/conversation/setConversationDraft.mdx @@ -247,7 +247,7 @@ IMSDK.asyncApi('setConversationDraft', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setConversationDraft({ +OpenIMSDK.setConversationDraft({ conversationID: string, draftText: string, }, operationID?: string): Promise @@ -271,16 +271,16 @@ OpenIMSDKRN.setConversationDraft({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.setConversationDraft({ +OpenIMSDK.setConversationDraft({ conversationID: '', draftText: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/acceptGroupApplication.mdx b/docs/sdks/api/group/acceptGroupApplication.mdx index 86f2a3e52c..8358f46b1e 100644 --- a/docs/sdks/api/group/acceptGroupApplication.mdx +++ b/docs/sdks/api/group/acceptGroupApplication.mdx @@ -272,7 +272,7 @@ IMSDK.asyncApi('acceptGroupApplication', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.acceptGroupApplication({ +OpenIMSDK.acceptGroupApplication({ groupID: string, fromUserID: string, handleMsg: string, @@ -298,17 +298,17 @@ OpenIMSDKRN.acceptGroupApplication({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.acceptGroupApplication({ +OpenIMSDK.acceptGroupApplication({ groupID: '', fromUserID: '', handleMsg: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/changeGroupMemberMute.mdx b/docs/sdks/api/group/changeGroupMemberMute.mdx index f8a1eccb8d..103b3dd681 100644 --- a/docs/sdks/api/group/changeGroupMemberMute.mdx +++ b/docs/sdks/api/group/changeGroupMemberMute.mdx @@ -273,7 +273,7 @@ IMSDK.asyncApi('changeGroupMemberMute', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.changeGroupMemberMute({ +OpenIMSDK.changeGroupMemberMute({ groupID: string, userID: string, mutedSeconds: number, @@ -300,17 +300,17 @@ OpenIMSDKRN.changeGroupMemberMute({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.changeGroupMemberMute({ +OpenIMSDK.changeGroupMemberMute({ groupID: '', userID: '', mutedSeconds: 7200, -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/changeGroupMute.mdx b/docs/sdks/api/group/changeGroupMute.mdx index 96e38c077b..fc77a9d57f 100644 --- a/docs/sdks/api/group/changeGroupMute.mdx +++ b/docs/sdks/api/group/changeGroupMute.mdx @@ -259,7 +259,7 @@ IMSDK.asyncApi('changeGroupMute', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.changeGroupMute({ +OpenIMSDK.changeGroupMute({ groupID: string, isMute: boolean, }, operationID?: string): Promise @@ -284,16 +284,16 @@ OpenIMSDKRN.changeGroupMute({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.changeGroupMute({ +OpenIMSDK.changeGroupMute({ groupID: '', isMute: true, -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/createGroup.mdx b/docs/sdks/api/group/createGroup.mdx index 17630cc815..38346bef22 100644 --- a/docs/sdks/api/group/createGroup.mdx +++ b/docs/sdks/api/group/createGroup.mdx @@ -291,7 +291,7 @@ IMSDK.asyncApi('createGroup', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createGroup({ +OpenIMSDK.createGroup({ groupInfo: Partial, memberUserIDs: string[], adminUserIDs?: string[], @@ -320,19 +320,19 @@ OpenIMSDKRN.createGroup({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createGroup({ +OpenIMSDK.createGroup({ groupInfo: { groupName: '', groupType: 2, }, memberUserIDs: [''], -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/dismissGroup.mdx b/docs/sdks/api/group/dismissGroup.mdx index a0894588dd..4b87b711e4 100644 --- a/docs/sdks/api/group/dismissGroup.mdx +++ b/docs/sdks/api/group/dismissGroup.mdx @@ -240,7 +240,7 @@ IMSDK.asyncApi('dismissGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.dismissGroup(groupID: string, operationID?: string): Promise +OpenIMSDK.dismissGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -260,13 +260,13 @@ OpenIMSDKRN.dismissGroup(groupID: string, operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.dismissGroup('groupID', 'operationID') +OpenIMSDK.dismissGroup('groupID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx b/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx index fceb790431..f2257c703e 100644 --- a/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx +++ b/docs/sdks/api/group/getGroupApplicationListAsApplicant.mdx @@ -235,7 +235,7 @@ IMSDK.asyncApi('getGroupApplicationListAsApplicant', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupApplicationListAsApplicant(req: { +OpenIMSDK.getGroupApplicationListAsApplicant(req: { groupIDs: string[]; handleResults: number[] offset: number; @@ -263,13 +263,18 @@ OpenIMSDKRN.getGroupApplicationListAsApplicant(req: { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getGroupApplicationListAsApplicant('operationID') +OpenIMSDK.getGroupApplicationListAsApplicant({ + offset: 0, + count: 10, + groupIDs: ['groupID1', 'groupID2'], + handleResults: [], +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx b/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx index 0a4762e331..1148776dc0 100644 --- a/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx +++ b/docs/sdks/api/group/getGroupApplicationListAsRecipient.mdx @@ -236,7 +236,7 @@ IMSDK.asyncApi('getGroupApplicationListAsRecipient', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupApplicationListAsRecipient(req: { +OpenIMSDK.getGroupApplicationListAsRecipient(req: { groupIDs: string[]; handleResults: number[] offset: number; @@ -264,13 +264,18 @@ OpenIMSDKRN.getGroupApplicationListAsRecipient(req: { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getGroupApplicationListAsRecipient('operationID') +OpenIMSDK.getGroupApplicationListAsRecipient({ + offset: 0, + count: 10, + handleResults: [], + groupIDs: ['groupID1', 'groupID2'], +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getGroupMemberList.mdx b/docs/sdks/api/group/getGroupMemberList.mdx index da16920f35..6899db5aaa 100644 --- a/docs/sdks/api/group/getGroupMemberList.mdx +++ b/docs/sdks/api/group/getGroupMemberList.mdx @@ -283,7 +283,7 @@ IMSDK.asyncApi('getGroupMemberList', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupMemberList({ +OpenIMSDK.getGroupMemberList({ groupID: string, filter: GroupMemberFilter, offset: number, @@ -311,18 +311,18 @@ OpenIMSDKRN.getGroupMemberList({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getGroupMemberList({ +OpenIMSDK.getGroupMemberList({ groupID: '', filter: 0, offset: 0, count: 20, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx b/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx index 3e1204d635..72a0fa2ca4 100644 --- a/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx +++ b/docs/sdks/api/group/getGroupMemberListByJoinTimeFilter.mdx @@ -302,7 +302,7 @@ IMSDK.asyncApi('getGroupMemberListByJoinTimeFilter', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupMemberListByJoinTimeFilter({ +OpenIMSDK.getGroupMemberListByJoinTimeFilter({ groupID: string, offset: number, count: number, @@ -334,20 +334,20 @@ OpenIMSDKRN.getGroupMemberListByJoinTimeFilter({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getGroupMemberListByJoinTimeFilter({ +OpenIMSDK.getGroupMemberListByJoinTimeFilter({ groupID: '', offset: 0, count: 20, joinTimeBegin: 0, joinTimeEnd: 0, filterUserIDList: ['userID'], -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx b/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx index f1d4972c04..583fcb00d5 100644 --- a/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx +++ b/docs/sdks/api/group/getGroupMemberOwnerAndAdmin.mdx @@ -231,7 +231,7 @@ IMSDK.asyncApi('getGroupMemberOwnerAndAdmin', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getGroupMemberOwnerAndAdmin(groupID: string, operationID?: string): Promise +OpenIMSDK.getGroupMemberOwnerAndAdmin(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -251,13 +251,13 @@ OpenIMSDKRN.getGroupMemberOwnerAndAdmin(groupID: string, operationID?: string): ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getGroupMemberOwnerAndAdmin('groupID', 'operationID') +OpenIMSDK.getGroupMemberOwnerAndAdmin('groupID') .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getJoinedGroupList.mdx b/docs/sdks/api/group/getJoinedGroupList.mdx index 83480ce6d7..c91d2b2f2e 100644 --- a/docs/sdks/api/group/getJoinedGroupList.mdx +++ b/docs/sdks/api/group/getJoinedGroupList.mdx @@ -216,7 +216,7 @@ IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getJoinedGroupList(operationID?: string): Promise +OpenIMSDK.getJoinedGroupList(operationID?: string): Promise ``` ### 输入参数 @@ -235,13 +235,13 @@ OpenIMSDKRN.getJoinedGroupList(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; - OpenIMSDKRN.getJoinedGroupList('operationID') + OpenIMSDK.getJoinedGroupList() .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getJoinedGroupListPage.mdx b/docs/sdks/api/group/getJoinedGroupListPage.mdx index 5444c9086d..8c070dc012 100644 --- a/docs/sdks/api/group/getJoinedGroupListPage.mdx +++ b/docs/sdks/api/group/getJoinedGroupListPage.mdx @@ -242,7 +242,7 @@ IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid(), { offset: 0, count: 1000 }) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getJoinedGroupList({ +OpenIMSDK.getJoinedGroupList({ offset: number; count: number; }, operationID?: string): Promise @@ -266,16 +266,16 @@ OpenIMSDKRN.getJoinedGroupList({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; - OpenIMSDKRN.getJoinedGroupList({ + OpenIMSDK.getJoinedGroupList({ offset: 0; count: 1000; -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx b/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx index d88730dbaf..0fb464962b 100644 --- a/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx +++ b/docs/sdks/api/group/getSpecifiedGroupMembersInfo.mdx @@ -257,7 +257,7 @@ IMSDK.asyncApi('getSpecifiedGroupMembersInfo', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSpecifiedGroupMembersInfo({ +OpenIMSDK.getSpecifiedGroupMembersInfo({ groupID: string, userIDList: string[], }, operationID?: string): Promise @@ -281,16 +281,16 @@ OpenIMSDKRN.getSpecifiedGroupMembersInfo({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getSpecifiedGroupMembersInfo({ +OpenIMSDK.getSpecifiedGroupMembersInfo({ groupID: '', userIDList: ['userID'], -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx b/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx index 36141c49bb..6617dcf531 100644 --- a/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx +++ b/docs/sdks/api/group/getSpecifiedGroupsInfo.mdx @@ -233,7 +233,7 @@ IMSDK.asyncApi('getSpecifiedGroupsInfo', IMSDK.uuid(), groupIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID?: string): Promise +OpenIMSDK.getSpecifiedGroupsInfo(groupIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -253,14 +253,14 @@ OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList: string[], operationID?: string): ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const groupIDList = ['userID1', 'userID2']; -OpenIMSDKRN.getSpecifiedGroupsInfo(groupIDList, 'operationID') +OpenIMSDK.getSpecifiedGroupsInfo(groupIDList) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/getUsersInGroup.mdx b/docs/sdks/api/group/getUsersInGroup.mdx index 23fb80403e..8d20f8174d 100644 --- a/docs/sdks/api/group/getUsersInGroup.mdx +++ b/docs/sdks/api/group/getUsersInGroup.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('getUsersInGroup', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getUsersInGroup({ +OpenIMSDK.getUsersInGroup({ groupID: string; userIDList: string[]; }, operationID?: string): Promise @@ -274,16 +274,16 @@ OpenIMSDKRN.getUsersInGroup({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.dismissGroup({ +OpenIMSDK.dismissGroup({ groupID: 'groupID', userIDList: ['userIDList'], -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/inviteUserToGroup.mdx b/docs/sdks/api/group/inviteUserToGroup.mdx index e3127cd622..463ad877cb 100644 --- a/docs/sdks/api/group/inviteUserToGroup.mdx +++ b/docs/sdks/api/group/inviteUserToGroup.mdx @@ -285,7 +285,7 @@ IMSDK.asyncApi('inviteUserToGroup', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.inviteUserToGroup({ +OpenIMSDK.inviteUserToGroup({ groupID: string, reason: string, userIDList: string[], @@ -311,17 +311,17 @@ OpenIMSDKRN.inviteUserToGroup({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.inviteUserToGroup({ +OpenIMSDK.inviteUserToGroup({ groupID: '', reason: '', userIDList: ['userID'], -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/isJoinGroup.mdx b/docs/sdks/api/group/isJoinGroup.mdx index 518f2eb90a..010fbbbbd2 100644 --- a/docs/sdks/api/group/isJoinGroup.mdx +++ b/docs/sdks/api/group/isJoinGroup.mdx @@ -229,7 +229,7 @@ IMSDK.asyncApi('isJoinGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.isJoinGroup(groupID: string, operationID?: string): Promise +OpenIMSDK.isJoinGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -249,13 +249,13 @@ OpenIMSDKRN.isJoinGroup(groupID: string, operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.isJoinGroup('groupID', 'operationID') +OpenIMSDK.isJoinGroup('groupID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/joinGroup.mdx b/docs/sdks/api/group/joinGroup.mdx index dc1508be76..37bad9e368 100644 --- a/docs/sdks/api/group/joinGroup.mdx +++ b/docs/sdks/api/group/joinGroup.mdx @@ -262,7 +262,7 @@ IMSDK.asyncApi('joinGroup', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.joinGroup({ +OpenIMSDK.joinGroup({ groupID: string, reqMsg: string, joinSource: GroupJoinSource.Search, @@ -288,17 +288,17 @@ OpenIMSDKRN.joinGroup({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.joinGroup({ +OpenIMSDK.joinGroup({ groupID: '', reqMsg: '', joinSource: GroupJoinSource.Search, -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/kickGroupMember.mdx b/docs/sdks/api/group/kickGroupMember.mdx index 866d1f3d74..ef7b0406d1 100644 --- a/docs/sdks/api/group/kickGroupMember.mdx +++ b/docs/sdks/api/group/kickGroupMember.mdx @@ -287,7 +287,7 @@ IMSDK.asyncApi('kickGroupMember', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.kickGroupMember({ +OpenIMSDK.kickGroupMember({ groupID: string, reason: string, userIDList: string[], @@ -313,17 +313,17 @@ OpenIMSDKRN.kickGroupMember({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.kickGroupMember({ +OpenIMSDK.kickGroupMember({ groupID: '', reason: '', userIDList: ['userID'], -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/quitGroup.mdx b/docs/sdks/api/group/quitGroup.mdx index 9457c7e298..7ebbdd64e4 100644 --- a/docs/sdks/api/group/quitGroup.mdx +++ b/docs/sdks/api/group/quitGroup.mdx @@ -240,7 +240,7 @@ IMSDK.asyncApi('quitGroup', IMSDK.uuid(), 'groupID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.quitGroup(groupID: string, operationID?: string): Promise +OpenIMSDK.quitGroup(groupID: string, operationID?: string): Promise ``` ### 输入参数 @@ -258,13 +258,13 @@ OpenIMSDKRN.quitGroup(groupID: string, operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.quitGroup('groupID', 'operationID') +OpenIMSDK.quitGroup('groupID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/refuseGroupApplication.mdx b/docs/sdks/api/group/refuseGroupApplication.mdx index e5f3187015..5fb1e3a4c8 100644 --- a/docs/sdks/api/group/refuseGroupApplication.mdx +++ b/docs/sdks/api/group/refuseGroupApplication.mdx @@ -269,7 +269,7 @@ IMSDK.asyncApi('refuseGroupApplication', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.refuseGroupApplication({ +OpenIMSDK.refuseGroupApplication({ groupID: string, fromUserID: string, handleMsg: string, @@ -295,17 +295,17 @@ OpenIMSDKRN.refuseGroupApplication({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.refuseGroupApplication({ +OpenIMSDK.refuseGroupApplication({ groupID: '', fromUserID: '', handleMsg: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/searchGroupMembers.mdx b/docs/sdks/api/group/searchGroupMembers.mdx index 904f538dd5..0303fb008c 100644 --- a/docs/sdks/api/group/searchGroupMembers.mdx +++ b/docs/sdks/api/group/searchGroupMembers.mdx @@ -298,7 +298,7 @@ IMSDK.asyncApi('searchGroupMembers', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.searchGroupMembers({ +OpenIMSDK.searchGroupMembers({ groupID: string; keywordList: string[]; isSearchUserID: boolean; @@ -330,20 +330,20 @@ OpenIMSDKRN.searchGroupMembers({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.searchGroupMembers({ +OpenIMSDK.searchGroupMembers({ groupID: '', keywordList: ['nickname'], isSearchUserID: false, isSearchMemberNickname: true, offset: 0, count: 20, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/searchGroups.mdx b/docs/sdks/api/group/searchGroups.mdx index e5f4f93ceb..8b57bbc3d1 100644 --- a/docs/sdks/api/group/searchGroups.mdx +++ b/docs/sdks/api/group/searchGroups.mdx @@ -262,7 +262,7 @@ IMSDK.asyncApi('searchGroups', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.searchGroups({ +OpenIMSDK.searchGroups({ keywordList: string[]; isSearchGroupID: boolean; isSearchGroupName: boolean; @@ -288,18 +288,18 @@ OpenIMSDKRN.searchGroups({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.searchGroups({ +OpenIMSDK.searchGroups({ keywordList: ['nickname']; isSearchUserID: false, isSearchNickname: true, isSearchRemark: true, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/setGroupInfo.mdx b/docs/sdks/api/group/setGroupInfo.mdx index ceab634166..a5063968c5 100644 --- a/docs/sdks/api/group/setGroupInfo.mdx +++ b/docs/sdks/api/group/setGroupInfo.mdx @@ -275,7 +275,7 @@ IMSDK.asyncApi('setGroupInfo', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setGroupInfo({ +OpenIMSDK.setGroupInfo({ groupID: string; faceURL?: string; groupName?: string; @@ -313,19 +313,18 @@ OpenIMSDKRN.setGroupInfo({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; -OpenIMSDKRN.setGroupInfo( +OpenIMSDK.setGroupInfo( { groupID: 'groupID', groupName: 'new name', - }, - 'operationID' + } ) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/setGroupMemberInfo.mdx b/docs/sdks/api/group/setGroupMemberInfo.mdx index 4255db47ac..adc792aa02 100644 --- a/docs/sdks/api/group/setGroupMemberInfo.mdx +++ b/docs/sdks/api/group/setGroupMemberInfo.mdx @@ -259,7 +259,7 @@ IMSDK.asyncApi('setGroupMemberInfo', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setGroupMemberInfo({ +OpenIMSDK.setGroupMemberInfo({ groupID: string; userID: string; nickname?: string; @@ -291,17 +291,17 @@ OpenIMSDKRN.setGroupMemberInfo({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.setGroupMemberInfo({ +OpenIMSDK.setGroupMemberInfo({ groupID: '', userID: '', nickname: 'new name', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/group/transferGroupOwner.mdx b/docs/sdks/api/group/transferGroupOwner.mdx index 00a45b10f9..84bc8629f9 100644 --- a/docs/sdks/api/group/transferGroupOwner.mdx +++ b/docs/sdks/api/group/transferGroupOwner.mdx @@ -262,7 +262,7 @@ IMSDK.asyncApi('transferGroupOwner', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.transferGroupOwner({ +OpenIMSDK.transferGroupOwner({ groupID: string, newOwnerUserID: string, }, operationID?: string): Promise @@ -286,17 +286,17 @@ OpenIMSDKRN.transferGroupOwner({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.transferGroupOwner({ +OpenIMSDK.transferGroupOwner({ groupID: '', newOwnerUserID: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/initialization/getLoginStatus.mdx b/docs/sdks/api/initialization/getLoginStatus.mdx index 4a93af785e..9bb5682293 100644 --- a/docs/sdks/api/initialization/getLoginStatus.mdx +++ b/docs/sdks/api/initialization/getLoginStatus.mdx @@ -193,7 +193,7 @@ IMSDK.asyncApi('getLoginStatus', 'operationID'); ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.getLoginStatus(operationID?: string): Promise +OpenIMSDK.getLoginStatus(operationID?: string): Promise ``` ### 输入参数 @@ -213,13 +213,13 @@ OpenIMSDKRN.getLoginStatus(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getLoginStatus("operationID"); +OpenIMSDK.getLoginStatus(); .then((data) => { // data: 登录状态LoginStatus }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/initialization/getLoginUserID.mdx b/docs/sdks/api/initialization/getLoginUserID.mdx index e5e08ff288..27d576905f 100644 --- a/docs/sdks/api/initialization/getLoginUserID.mdx +++ b/docs/sdks/api/initialization/getLoginUserID.mdx @@ -189,7 +189,7 @@ IMSDK.asyncApi('getLoginUserID', 'operationID') ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.getLoginUserID(operationID?: string): Promise +OpenIMSDK.getLoginUserID(operationID?: string): Promise ``` ### 返回结果 @@ -202,18 +202,17 @@ OpenIMSDKRN.getLoginUserID(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getLoginUserID("operationID"); +OpenIMSDK.getLoginUserID(); .then((data) => { // data: 当前登录用户userID }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` - diff --git a/docs/sdks/api/initialization/initSDK.mdx b/docs/sdks/api/initialization/initSDK.mdx index 2c3e3c9228..068c48a358 100644 --- a/docs/sdks/api/initialization/initSDK.mdx +++ b/docs/sdks/api/initialization/initSDK.mdx @@ -321,7 +321,7 @@ export const getDbDir = () => ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.initSDK(config: InitConfig, optionalID? :string): Promise +OpenIMSDK.initSDK(config: InitConfig, optionalID? :string): Promise ``` ### 输入参数 @@ -341,19 +341,20 @@ OpenIMSDKRN.initSDK(config: InitConfig, optionalID? :string): Promise ### 代码示例 ```ts showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; import RNFS from 'react-native-fs'; RNFS.mkdir(RNFS.DocumentDirectoryPath + '/tmp'); -OpenIMSDKRN.initSDK({ +OpenIMSDK.initSDK({ platformID: 2, // 1: ios, 2: android apiAddr: 'http://your-server-ip:10002', wsAddr: 'ws://your-server-ip:10001', dataDir: RNFS.DocumentDirectoryPath + '/tmp', + logFilePath: RNFS.DocumentDirectoryPath + '/tmp', logLevel: 5, isLogStandardOutput: true, -}, 'operationID'); +}); ``` diff --git a/docs/sdks/api/initialization/login.mdx b/docs/sdks/api/initialization/login.mdx index 3270921418..747aea88f7 100644 --- a/docs/sdks/api/initialization/login.mdx +++ b/docs/sdks/api/initialization/login.mdx @@ -290,7 +290,7 @@ IMSDK.asyncApi('login', IMSDK.uuid(), { ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.login({ +OpenIMSDK.login({ userID:string, token:string }, operationID?: string): Promise @@ -314,16 +314,16 @@ OpenIMSDKRN.login({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; -OpenIMSDKRN.login({ +OpenIMSDK.login({ userID: 'IM user ID', token: 'IM user token', -}, 'operationID') +}) .then(() => { // 登录成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 登录失败 }); ``` diff --git a/docs/sdks/api/initialization/logout.mdx b/docs/sdks/api/initialization/logout.mdx index a5c32df100..d2ef6245c4 100644 --- a/docs/sdks/api/initialization/logout.mdx +++ b/docs/sdks/api/initialization/logout.mdx @@ -224,7 +224,7 @@ IMSDK.asyncApi('logout', IMSDK.uuid()) ### 函数原型 ```js showLineNumbers -OpenIMSDKRN.logout(operationID?: string): Promise +OpenIMSDK.logout(operationID?: string): Promise ``` ### 参数详解 @@ -244,13 +244,13 @@ OpenIMSDKRN.logout(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.logout("operationID") +OpenIMSDK.logout() .then(() => { // 退出登录成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/initialization/unInitSDK.mdx b/docs/sdks/api/initialization/unInitSDK.mdx index 3f735d1bea..a9253565a7 100644 --- a/docs/sdks/api/initialization/unInitSDK.mdx +++ b/docs/sdks/api/initialization/unInitSDK.mdx @@ -146,7 +146,7 @@ IMSDK.asyncApi('unInitSDK', IMSDK.uuid(), config) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.unInitSDK(operationID?: string): Promise +OpenIMSDK.unInitSDK(operationID?: string): Promise ``` ### 输入参数 @@ -165,13 +165,13 @@ OpenIMSDKRN.unInitSDK(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.unInitSDK("operationID") +OpenIMSDK.unInitSDK() .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createCardMessage.mdx b/docs/sdks/api/message/createCardMessage.mdx index c05f78c67d..5762cdd1ac 100644 --- a/docs/sdks/api/message/createCardMessage.mdx +++ b/docs/sdks/api/message/createCardMessage.mdx @@ -248,7 +248,7 @@ IMSDK.asyncApi('createCardMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.login({ +OpenIMSDK.login({ userID:string, nickname:string, faceURL:string, @@ -275,18 +275,18 @@ OpenIMSDKRN.login({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createCardMessage({ +OpenIMSDK.createCardMessage({ userID: '', nickname: '', faceURL: '', ex: '', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createCustomMessage.mdx b/docs/sdks/api/message/createCustomMessage.mdx index 96eb152341..d3a3d0b30c 100644 --- a/docs/sdks/api/message/createCustomMessage.mdx +++ b/docs/sdks/api/message/createCustomMessage.mdx @@ -244,7 +244,7 @@ IMSDK.asyncApi('createCustomMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createCustomMessage({ +OpenIMSDK.createCustomMessage({ data: string, extension: string, description: string @@ -270,17 +270,17 @@ OpenIMSDKRN.createCustomMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createCustomMessage({ +OpenIMSDK.createCustomMessage({ data: '', extension: '', description: '', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createFaceMessage.mdx b/docs/sdks/api/message/createFaceMessage.mdx index 11911f3e7f..3bfb9cd975 100644 --- a/docs/sdks/api/message/createFaceMessage.mdx +++ b/docs/sdks/api/message/createFaceMessage.mdx @@ -238,7 +238,7 @@ IMSDK.asyncApi('createFaceMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createFaceMessage({ +OpenIMSDK.createFaceMessage({ index: number; dataStr: string; }, operationID?: string): Promise @@ -263,16 +263,16 @@ OpenIMSDKRN.createFaceMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createFaceMessage({ +OpenIMSDK.createFaceMessage({ index: 0, dataStr: 'https://xxx/xxx/xx.png', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createFileMessageByURL.mdx b/docs/sdks/api/message/createFileMessageByURL.mdx index 7abb3da5ee..d0ac0f9c9a 100644 --- a/docs/sdks/api/message/createFileMessageByURL.mdx +++ b/docs/sdks/api/message/createFileMessageByURL.mdx @@ -257,7 +257,7 @@ IMSDK.asyncApi('createFileMessageByURL', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createFileMessageByURL( { +OpenIMSDK.createFileMessageByURL( { filePath: string, fileName: string, uuid: string, @@ -288,20 +288,20 @@ OpenIMSDKRN.createFileMessageByURL( { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createFileMessageByURL({ +OpenIMSDK.createFileMessageByURL({ filePath: '', fileName: 'fileName.mp4', uuid: 'uuid', sourceUrl: 'https://sourceUrl.mp4', fileSize: 1024, fileType: 'mp4', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createFileMessageFromFullPath.mdx b/docs/sdks/api/message/createFileMessageFromFullPath.mdx index efccb23098..1e71567b2c 100644 --- a/docs/sdks/api/message/createFileMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createFileMessageFromFullPath.mdx @@ -229,7 +229,7 @@ IMSDK.asyncApi('createFileMessageFromFullPath', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createFileMessageFromFullPath({ +OpenIMSDK.createFileMessageFromFullPath({ filePath: string, fileName: string }, operationID?: string): Promise @@ -255,16 +255,16 @@ OpenIMSDKRN.createFileMessageFromFullPath({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createFileMessageFromFullPath({ +OpenIMSDK.createFileMessageFromFullPath({ filePath: '', fileName: '', -}, 'operationID') +}) .then(({ data }) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createForwardMessage.mdx b/docs/sdks/api/message/createForwardMessage.mdx index c4937a8920..733151b339 100644 --- a/docs/sdks/api/message/createForwardMessage.mdx +++ b/docs/sdks/api/message/createForwardMessage.mdx @@ -215,7 +215,7 @@ IMSDK.asyncApi('createForwardMessage', IMSDK.uuid(), message) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createForwardMessage( message: MessageItem, operationID?: string): Promise +OpenIMSDK.createForwardMessage( message: MessageItem, operationID?: string): Promise ``` ### 输入参数 @@ -235,15 +235,15 @@ OpenIMSDKRN.createForwardMessage( message: MessageItem, operationID?: string): P ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const message = {...} as MessageItem; -OpenIMSDKRN.createForwardMessage(message, 'operationID') +OpenIMSDK.createForwardMessage(message) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createImageMessageByURL.mdx b/docs/sdks/api/message/createImageMessageByURL.mdx index 72cd5662d7..378971a6e7 100644 --- a/docs/sdks/api/message/createImageMessageByURL.mdx +++ b/docs/sdks/api/message/createImageMessageByURL.mdx @@ -284,7 +284,7 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createImageMessageByURL({ +OpenIMSDK.createImageMessageByURL({ sourcePicture: PicBaseInfo, bigPicture: PicBaseInfo, snapshotPicture: PicBaseInfo, @@ -311,7 +311,7 @@ OpenIMSDKRN.createImageMessageByURL({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const picBaseInfo = { uuid: 'uuid', @@ -322,16 +322,16 @@ const picBaseInfo = { url: 'http://xxx.com/xxx.png', }; -OpenIMSDKRN.createImageMessageByURL({ +OpenIMSDK.createImageMessageByURL({ sourcePicture: picBaseInfo, bigPicture: picBaseInfo, snapshotPicture: picBaseInfo, sourcePath: "" -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createImageMessageFromFullPath.mdx b/docs/sdks/api/message/createImageMessageFromFullPath.mdx index 550a2fc43e..6e265a5874 100644 --- a/docs/sdks/api/message/createImageMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createImageMessageFromFullPath.mdx @@ -213,7 +213,7 @@ IMSDK.asyncApi('createImageMessageFromFullPath', IMSDK.uuid(), 'imagePath') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createImageMessageFromFullPath(imagePath: string, operationID?: string): Promise +OpenIMSDK.createImageMessageFromFullPath(imagePath: string, operationID?: string): Promise ``` ### 输入参数 @@ -233,13 +233,13 @@ OpenIMSDKRN.createImageMessageFromFullPath(imagePath: string, operationID?: stri ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createImageMessageFromFullPath('imagePath', 'operationID') +OpenIMSDK.createImageMessageFromFullPath('imagePath') .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createLocationMessage.mdx b/docs/sdks/api/message/createLocationMessage.mdx index 2a53d0f406..011a3dbde5 100644 --- a/docs/sdks/api/message/createLocationMessage.mdx +++ b/docs/sdks/api/message/createLocationMessage.mdx @@ -245,7 +245,7 @@ IMSDK.asyncApi('createLocationMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createLocationMessage({ +OpenIMSDK.createLocationMessage({ description: string, longitude: number, latitude: number, @@ -271,17 +271,17 @@ OpenIMSDKRN.createLocationMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createLocationMessage({ +OpenIMSDK.createLocationMessage({ description: '', longitude: 0, latitude: 0, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createMergeMessage.mdx b/docs/sdks/api/message/createMergeMessage.mdx index 9e51779d82..750919993f 100644 --- a/docs/sdks/api/message/createMergeMessage.mdx +++ b/docs/sdks/api/message/createMergeMessage.mdx @@ -257,7 +257,7 @@ IMSDK.asyncApi('createMergerMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createMergerMessage({ +OpenIMSDK.createMergerMessage({ title: string, messageList: Array, summaryList: Array, @@ -283,9 +283,9 @@ OpenIMSDKRN.createMergerMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createMergerMessage({ +OpenIMSDK.createMergerMessage({ messageList: [ { // message @@ -298,7 +298,7 @@ OpenIMSDKRN.createMergerMessage({ .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createQuoteMessage.mdx b/docs/sdks/api/message/createQuoteMessage.mdx index d6ef96ad5e..9d2fb443c7 100644 --- a/docs/sdks/api/message/createQuoteMessage.mdx +++ b/docs/sdks/api/message/createQuoteMessage.mdx @@ -235,7 +235,7 @@ IMSDK.asyncApi('createQuoteMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createQuoteMessage({ +OpenIMSDK.createQuoteMessage({ text: string, message: MessageItem, }, operationID?: string): Promise @@ -259,20 +259,20 @@ OpenIMSDKRN.createQuoteMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const message = { ... } as MessageItem -OpenIMSDKRN.createQuoteMessage({ +OpenIMSDK.createQuoteMessage({ text: '', message: { ... }, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createSoundMessageByURL.mdx b/docs/sdks/api/message/createSoundMessageByURL.mdx index 230c557fbf..1a159b1414 100644 --- a/docs/sdks/api/message/createSoundMessageByURL.mdx +++ b/docs/sdks/api/message/createSoundMessageByURL.mdx @@ -257,7 +257,7 @@ IMSDK.asyncApi('createSoundMessageByURL', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createSoundMessageByURL({ +OpenIMSDK.createSoundMessageByURL({ uuid: string, soundPath: string, sourceUrl: string, @@ -289,20 +289,20 @@ OpenIMSDKRN.createSoundMessageByURL({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createSoundMessageByURL({ +OpenIMSDK.createSoundMessageByURL({ soundPath: '', duration: 6, uuid: 'uuid', sourceUrl: '', dataSize: 1024, soundType: 'mp3', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createSoundMessageFromFullPath.mdx b/docs/sdks/api/message/createSoundMessageFromFullPath.mdx index 3da8635705..a350162abd 100644 --- a/docs/sdks/api/message/createSoundMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createSoundMessageFromFullPath.mdx @@ -226,7 +226,7 @@ IMSDK.asyncApi('createSoundMessageFromFullPath', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createSoundMessageFromFullPath({ +OpenIMSDK.createSoundMessageFromFullPath({ soundPath: string, duration: number, }, operationID?: string): Promise @@ -250,16 +250,16 @@ OpenIMSDKRN.createSoundMessageFromFullPath({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createSoundMessageFromFullPath({ +OpenIMSDK.createSoundMessageFromFullPath({ soundPath: 'soundPath', duration: 6, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createTextAtMessage.mdx b/docs/sdks/api/message/createTextAtMessage.mdx index b6e2dc7c33..e298eae5ae 100644 --- a/docs/sdks/api/message/createTextAtMessage.mdx +++ b/docs/sdks/api/message/createTextAtMessage.mdx @@ -305,7 +305,7 @@ IMSDK.asyncApi('createTextAtMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createTextAtMessage({ +OpenIMSDK.createTextAtMessage({ text: string, atUserIDList: string[], atUsersInfo: AtUsersInfoItem[]; @@ -333,9 +333,9 @@ OpenIMSDKRN.createTextAtMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createTextAtMessage({ +OpenIMSDK.createTextAtMessage({ text: "", atUserIDList: ['userID'], atUsersInfo: [ @@ -348,11 +348,11 @@ OpenIMSDKRN.createTextAtMessage({ // MessageItem ... } -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createTextMessage.mdx b/docs/sdks/api/message/createTextMessage.mdx index fd4d4261d1..e72c2e7f9c 100644 --- a/docs/sdks/api/message/createTextMessage.mdx +++ b/docs/sdks/api/message/createTextMessage.mdx @@ -210,7 +210,7 @@ IMSDK.asyncApi('createTextMessage', IMSDK.uuid(), 'text') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createTextMessage(textMsg: string, operationID?: string): Promise +OpenIMSDK.createTextMessage(textMsg: string, operationID?: string): Promise ``` ### 输入参数 @@ -231,13 +231,13 @@ OpenIMSDKRN.createTextMessage(textMsg: string, operationID?: string): Promise { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createVideoMessageByURL.mdx b/docs/sdks/api/message/createVideoMessageByURL.mdx index 1a4a8434c9..3059b6d85c 100644 --- a/docs/sdks/api/message/createVideoMessageByURL.mdx +++ b/docs/sdks/api/message/createVideoMessageByURL.mdx @@ -303,7 +303,7 @@ IMSDK.asyncApi('createVideoMessageByURL', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createVideoMessageByURL({ +OpenIMSDK.createVideoMessageByURL({ videoPath: string, duration: number, videoType: string, @@ -349,9 +349,9 @@ OpenIMSDKRN.createVideoMessageByURL({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createVideoMessageByURL({ +OpenIMSDK.createVideoMessageByURL({ videoPath: '', duration: 6, videoType: 'mp4', @@ -365,11 +365,11 @@ OpenIMSDKRN.createVideoMessageByURL({ snapshotWidth: 1024, snapshotHeight: 1024, snapShotType: 'png', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/createVideoMessageFromFullPath.mdx b/docs/sdks/api/message/createVideoMessageFromFullPath.mdx index 0774d09269..b9e293d53d 100644 --- a/docs/sdks/api/message/createVideoMessageFromFullPath.mdx +++ b/docs/sdks/api/message/createVideoMessageFromFullPath.mdx @@ -251,7 +251,7 @@ IMSDK.asyncApi('createVideoMessageFromFullPath', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.createVideoMessageFromFullPath({ +OpenIMSDK.createVideoMessageFromFullPath({ videoPath: string, videoType: string, duration: number, @@ -279,18 +279,18 @@ OpenIMSDKRN.createVideoMessageFromFullPath({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.createVideoMessageFromFullPath({ +OpenIMSDK.createVideoMessageFromFullPath({ videoPath: '', videoType: 'mp4', duration: 12, snapshotPath: '', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/deleteAllMsgFromLocal.mdx b/docs/sdks/api/message/deleteAllMsgFromLocal.mdx index fa83b42a75..23a1dc3ac3 100644 --- a/docs/sdks/api/message/deleteAllMsgFromLocal.mdx +++ b/docs/sdks/api/message/deleteAllMsgFromLocal.mdx @@ -215,7 +215,7 @@ IMSDK.asyncApi('deleteAllMsgFromLocal', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteAllMsgFromLocal(operationID?: string): Promise +OpenIMSDK.deleteAllMsgFromLocal(operationID?: string): Promise ``` ### 输入参数 @@ -234,13 +234,13 @@ OpenIMSDKRN.deleteAllMsgFromLocal(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.deleteAllMsgFromLocal('operationID') +OpenIMSDK.deleteAllMsgFromLocal() .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx b/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx index e387371268..508cb2ace4 100644 --- a/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx +++ b/docs/sdks/api/message/deleteAllMsgFromLocalAndSvr.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('deleteAllMsgFromLocalAndSvr', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteAllMsgFromLocalAndSvr(operationID?: string): Promise +OpenIMSDK.deleteAllMsgFromLocalAndSvr(operationID?: string): Promise ``` ### 输入参数 @@ -237,13 +237,13 @@ OpenIMSDKRN.deleteAllMsgFromLocalAndSvr(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.deleteAllMsgFromLocalAndSvr('operationID') +OpenIMSDK.deleteAllMsgFromLocalAndSvr() .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/deleteMessage.mdx b/docs/sdks/api/message/deleteMessage.mdx index cb7b8771f6..a3555d44e7 100644 --- a/docs/sdks/api/message/deleteMessage.mdx +++ b/docs/sdks/api/message/deleteMessage.mdx @@ -259,7 +259,7 @@ IMSDK.asyncApi('deleteMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteMessage({ +OpenIMSDK.deleteMessage({ conversationID: string, clientMsgID:string }, operationID?: string): Promise @@ -283,16 +283,16 @@ OpenIMSDKRN.deleteMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.deleteMessage({ +OpenIMSDK.deleteMessage({ conversationID: '', clientMsgID: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx b/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx index df8304215d..72d8174cf1 100644 --- a/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx +++ b/docs/sdks/api/message/deleteMessageFromLocalStorage.mdx @@ -249,7 +249,7 @@ IMSDK.asyncApi('deleteMessageFromLocalStorage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteMessageFromLocalStorage({ +OpenIMSDK.deleteMessageFromLocalStorage({ conversationID: string, clientMsgID:string }, operationID?: string): Promise @@ -273,16 +273,16 @@ OpenIMSDKRN.deleteMessageFromLocalStorage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.deleteMessageFromLocalStorage({ +OpenIMSDK.deleteMessageFromLocalStorage({ conversationID: '', clientMsgID: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/findMessageList.mdx b/docs/sdks/api/message/findMessageList.mdx index 5060c3ebfd..e6ce50b621 100644 --- a/docs/sdks/api/message/findMessageList.mdx +++ b/docs/sdks/api/message/findMessageList.mdx @@ -288,7 +288,7 @@ IMSDK.asyncApi('findMessageList', IMSDK.uuid(), { > [`SearchMessageResultItem`](docs/sdks/class/message/searchResultItem.mdx) ```ts showLineNumbers -OpenIMSDKRN.findMessageList({ +OpenIMSDK.findMessageList({ conversationID: string, clientMsgIDList: string[] }, operationID?: string): Promise @@ -312,19 +312,18 @@ OpenIMSDKRN.findMessageList({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; -OpenIMSDKRN.findMessageList( +OpenIMSDK.findMessageList( { conversationID: '', clientMsgIDList: ['msgid'], }, - 'operationID' ) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx index 33eaaa5445..2964d2d01b 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx @@ -274,7 +274,7 @@ IMSDK.asyncApi('getAdvancedHistoryMessageList', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getAdvancedHistoryMessageList({ +OpenIMSDK.getAdvancedHistoryMessageList({ lastMinSeq: number; count: number; startClientMsgID: string; @@ -302,18 +302,18 @@ OpenIMSDKRN.getAdvancedHistoryMessageList({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getAdvancedHistoryMessageList({ +OpenIMSDK.getAdvancedHistoryMessageList({ lastMinSeq: 0, count: 20, startClientMsgID: '', conversationID: 'conversationID', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx index c86b133093..a5e008278c 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -267,7 +267,7 @@ IMSDK.asyncApi('getAdvancedHistoryMessageListReverse', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getAdvancedHistoryMessageListReverse({ +OpenIMSDK.getAdvancedHistoryMessageListReverse({ lastMinSeq: number; count: number; startClientMsgID: string; @@ -295,18 +295,18 @@ OpenIMSDKRN.getAdvancedHistoryMessageListReverse({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getAdvancedHistoryMessageListReverse({ +OpenIMSDK.getAdvancedHistoryMessageListReverse({ lastMinSeq: 0, count: 20, startClientMsgID: '', conversationID: 'conversationID', -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx b/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx index b299ec05bf..99df353214 100644 --- a/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx +++ b/docs/sdks/api/message/insertGroupMessageToLocalStorage.mdx @@ -271,7 +271,7 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.insertGroupMessageToLocalStorage({ +OpenIMSDK.insertGroupMessageToLocalStorage({ message: MessageItem; groupID: string; sendID: string; @@ -297,20 +297,20 @@ OpenIMSDKRN.insertGroupMessageToLocalStorage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.insertGroupMessageToLocalStorage({ +OpenIMSDK.insertGroupMessageToLocalStorage({ message: { // MessageItem ... - }; + }, groupID: "", sendID: "", -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx b/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx index b149698247..38715926c6 100644 --- a/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx +++ b/docs/sdks/api/message/insertSingleMessageToLocalStorage.mdx @@ -273,7 +273,7 @@ IMSDK.asyncApi( ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.insertSingleMessageToLocalStorage({ +OpenIMSDK.insertSingleMessageToLocalStorage({ message: MessageItem; recvID: string; sendID: string; @@ -299,20 +299,20 @@ OpenIMSDKRN.insertSingleMessageToLocalStorage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.insertSingleMessageToLocalStorage({ +OpenIMSDK.insertSingleMessageToLocalStorage({ message: { // MessageItem ... - }; + }, recvID: "", sendID: "", -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/revokeMessage.mdx b/docs/sdks/api/message/revokeMessage.mdx index 51bcf6eb9b..e51646b260 100644 --- a/docs/sdks/api/message/revokeMessage.mdx +++ b/docs/sdks/api/message/revokeMessage.mdx @@ -258,7 +258,7 @@ IMSDK.asyncApi('revokeMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.revokeMessage({ +OpenIMSDK.revokeMessage({ conversationID: string, clientMsgID: string, }, operationID?: string): Promise @@ -282,16 +282,16 @@ OpenIMSDKRN.revokeMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.revokeMessage({ +OpenIMSDK.revokeMessage({ conversationID: '', clientMsgID: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/searchLocalMessages.mdx b/docs/sdks/api/message/searchLocalMessages.mdx index 591357e1d0..b5b2d288a2 100644 --- a/docs/sdks/api/message/searchLocalMessages.mdx +++ b/docs/sdks/api/message/searchLocalMessages.mdx @@ -361,7 +361,7 @@ type SearchMessageResult = { searchResultItems: SearchMessageResultItem[]; }; -OpenIMSDKRN.searchLocalMessages( { +OpenIMSDK.searchLocalMessages( { conversationID?: string, keywordList: string[], keywordListMatchType?: number, @@ -399,9 +399,9 @@ OpenIMSDKRN.searchLocalMessages( { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.searchLocalMessages({ +OpenIMSDK.searchLocalMessages({ conversationID: '', keywordList: ['keyword'], keywordListMatchType: 0, @@ -411,11 +411,11 @@ OpenIMSDKRN.searchLocalMessages({ searchTimePeriod: 0, pageIndex: 1, count: 20, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/sendMessage.mdx b/docs/sdks/api/message/sendMessage.mdx index 19e9467f09..725678a6f9 100644 --- a/docs/sdks/api/message/sendMessage.mdx +++ b/docs/sdks/api/message/sendMessage.mdx @@ -303,7 +303,7 @@ IMSDK.asyncApi('sendMessage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.sendMessage({ +OpenIMSDK.sendMessage({ recvID: string, groupID: string, offlinePushInfo?: OfflinePush, @@ -331,9 +331,9 @@ OpenIMSDKRN.sendMessage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.sendMessage({ +OpenIMSDK.sendMessage({ recvID: "userID", groupID: "", message: { @@ -347,11 +347,11 @@ OpenIMSDKRN.sendMessage({ iOSPushSound: '+1', iOSBadgeCount: true, } -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/sendMessageNotOss.mdx b/docs/sdks/api/message/sendMessageNotOss.mdx index 85524be5c6..390da648ca 100644 --- a/docs/sdks/api/message/sendMessageNotOss.mdx +++ b/docs/sdks/api/message/sendMessageNotOss.mdx @@ -304,7 +304,7 @@ IMSDK.asyncApi('sendMessageNotOss', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.sendMessageNotOss({ +OpenIMSDK.sendMessageNotOss({ recvID: string; groupID: string; offlinePushInfo?: OfflinePush; @@ -332,9 +332,9 @@ OpenIMSDKRN.sendMessageNotOss({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.sendMessageNotOss({ +OpenIMSDK.sendMessageNotOss({ recvID: "userID", groupID: "", message: { @@ -348,11 +348,11 @@ OpenIMSDKRN.sendMessageNotOss({ iOSPushSound: '+1', iOSBadgeCount: true, } -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/setMessageLocalEx.mdx b/docs/sdks/api/message/setMessageLocalEx.mdx index 057e4da429..d4bc9550f9 100644 --- a/docs/sdks/api/message/setMessageLocalEx.mdx +++ b/docs/sdks/api/message/setMessageLocalEx.mdx @@ -254,7 +254,7 @@ IMSDK.asyncApi('setMessageLocalEx', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setMessageLocalEx( { +OpenIMSDK.setMessageLocalEx( { conversationID: string; clientMsgID: string; localEx: string; @@ -280,17 +280,17 @@ OpenIMSDKRN.setMessageLocalEx( { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.setMessageLocalEx({ +OpenIMSDK.setMessageLocalEx({ conversationID: 'conversationID', clientMsgID: 'clientMsgID', localEx: 'localEx', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/message/typingStatusUpdate.mdx b/docs/sdks/api/message/typingStatusUpdate.mdx index d23a82793f..f410389af5 100644 --- a/docs/sdks/api/message/typingStatusUpdate.mdx +++ b/docs/sdks/api/message/typingStatusUpdate.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('typingStatusUpdate', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.typingStatusUpdate({ +OpenIMSDK.typingStatusUpdate({ recvID: string, msgTip: string, }, operationID?: string): Promise @@ -274,16 +274,16 @@ OpenIMSDKRN.typingStatusUpdate({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.typingStatusUpdate({ +OpenIMSDK.typingStatusUpdate({ recvID: 'recvID', msgTip: 'yes', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/acceptFriendApplication.mdx b/docs/sdks/api/relation/acceptFriendApplication.mdx index 60bcfe9c3f..6a156d45be 100644 --- a/docs/sdks/api/relation/acceptFriendApplication.mdx +++ b/docs/sdks/api/relation/acceptFriendApplication.mdx @@ -247,7 +247,7 @@ IMSDK.asyncApi('acceptFriendApplication', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.acceptFriendApplication({ +OpenIMSDK.acceptFriendApplication({ toUserID: string; handleMsg: string; }, operationID?: string): Promise @@ -271,16 +271,16 @@ OpenIMSDKRN.acceptFriendApplication({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.acceptFriendApplication({ +OpenIMSDK.acceptFriendApplication({ toUserID: '', handleMsg: '', -}, 'operationID'); +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/addBlack.mdx b/docs/sdks/api/relation/addBlack.mdx index b71ed5603e..017dc9994b 100644 --- a/docs/sdks/api/relation/addBlack.mdx +++ b/docs/sdks/api/relation/addBlack.mdx @@ -232,7 +232,7 @@ IMSDK.asyncApi('addBlack', IMSDK.uuid(), { toUserID: 'userID' }) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.addBlack({ +OpenIMSDK.addBlack({ toUserID: string; ex?: string; }, operationID?: string): Promise; @@ -256,15 +256,15 @@ OpenIMSDKRN.addBlack({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.addBlack({ +OpenIMSDK.addBlack({ toUserID: 'userID', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/addFriend.mdx b/docs/sdks/api/relation/addFriend.mdx index b353e5eef5..0cccb6c6fe 100644 --- a/docs/sdks/api/relation/addFriend.mdx +++ b/docs/sdks/api/relation/addFriend.mdx @@ -243,7 +243,7 @@ IMSDK.asyncApi('addFriend', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.addFriend({ +OpenIMSDK.addFriend({ toUserID: string; reqMsg: string; }, operationID?: string): Promise @@ -267,16 +267,16 @@ OpenIMSDKRN.addFriend({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.addFriend({ +OpenIMSDK.addFriend({ toUserID: '', reqMsg: '', -}, 'operationID'); +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/checkFriend.mdx b/docs/sdks/api/relation/checkFriend.mdx index 1b63a2039f..223a5459e2 100644 --- a/docs/sdks/api/relation/checkFriend.mdx +++ b/docs/sdks/api/relation/checkFriend.mdx @@ -257,7 +257,7 @@ type FriendshipInfo = { result: number; // 1是好友 0非好友 userID: string; }; -OpenIMSDKRN.checkFriend(userIDList: string[], operationID?: string): Promise +OpenIMSDK.checkFriend(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -278,14 +278,14 @@ OpenIMSDKRN.checkFriend(userIDList: string[], operationID?: string): Promise { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/deleteFriend.mdx b/docs/sdks/api/relation/deleteFriend.mdx index 4a79022e53..0716af4d8b 100644 --- a/docs/sdks/api/relation/deleteFriend.mdx +++ b/docs/sdks/api/relation/deleteFriend.mdx @@ -224,7 +224,7 @@ IMSDK.asyncApi('deleteFriend', IMSDK.uuid(), 'userID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.deleteFriend(userID: string, operationID?: string): Promise; +OpenIMSDK.deleteFriend(userID: string, operationID?: string): Promise; ``` ### 输入参数 @@ -244,13 +244,13 @@ OpenIMSDKRN.deleteFriend(userID: string, operationID?: string): Promise; ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.deleteFriend('userID', 'operationID') +OpenIMSDK.deleteFriend('userID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getBlackList.mdx b/docs/sdks/api/relation/getBlackList.mdx index 2834e38947..1d5d771943 100644 --- a/docs/sdks/api/relation/getBlackList.mdx +++ b/docs/sdks/api/relation/getBlackList.mdx @@ -204,7 +204,7 @@ IMSDK.asyncApi('getBlackList', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getBlackList(operationID?: string): Promise +OpenIMSDK.getBlackList(operationID?: string): Promise ``` ### 输入参数 @@ -223,13 +223,13 @@ OpenIMSDKRN.getBlackList(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getBlackList('operationID') +OpenIMSDK.getBlackList() .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx b/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx index 9893b06c2e..e4d2ab28cf 100644 --- a/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx +++ b/docs/sdks/api/relation/getFriendApplicationListAsApplicant.mdx @@ -220,7 +220,7 @@ IMSDK.asyncApi('getFriendApplicationListAsApplicant', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendApplicationListAsApplicant(req: { +OpenIMSDK.getFriendApplicationListAsApplicant(req: { offset: number; count: number; }, operationID?: string): Promise @@ -244,13 +244,16 @@ OpenIMSDKRN.getFriendApplicationListAsApplicant(req: { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getFriendApplicationListAsApplicant('operationID') +OpenIMSDK.getFriendApplicationListAsApplicant({ + offset: 0, + count: 10, +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx b/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx index 601c4f6620..15592e5ac3 100644 --- a/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx +++ b/docs/sdks/api/relation/getFriendApplicationListAsRecipient.mdx @@ -220,7 +220,7 @@ IMSDK.asyncApi('getFriendApplicationListAsRecipient', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendApplicationListAsRecipient(req: { +OpenIMSDK.getFriendApplicationListAsRecipient(req: { offset: number; count: number; handleResults: number[] @@ -246,13 +246,17 @@ OpenIMSDKRN.getFriendApplicationListAsRecipient(req: { ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getFriendApplicationListAsRecipient('operationID') +OpenIMSDK.getFriendApplicationListAsRecipient({ + offset: 0, + count: 10, + handleResults: [], +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getFriendList.mdx b/docs/sdks/api/relation/getFriendList.mdx index d49a9d14bb..1295e01d8c 100644 --- a/docs/sdks/api/relation/getFriendList.mdx +++ b/docs/sdks/api/relation/getFriendList.mdx @@ -218,7 +218,7 @@ IMSDK.asyncApi('getFriendList', IMSDK.uuid(), false) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID?: string): Promise +OpenIMSDK.getFriendList(filterBlack: boolean, operationID?: string): Promise ``` ### 输入参数 @@ -238,13 +238,13 @@ OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID?: string): Promise { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getFriendListPage.mdx b/docs/sdks/api/relation/getFriendListPage.mdx index c4341ff678..f48b97a417 100644 --- a/docs/sdks/api/relation/getFriendListPage.mdx +++ b/docs/sdks/api/relation/getFriendListPage.mdx @@ -254,7 +254,7 @@ IMSDK.asyncApi('getFriendListPage', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getFriendListPage({ +OpenIMSDK.getFriendListPage({ offset: number; count: number; filterBlack?: boolean; @@ -280,16 +280,16 @@ OpenIMSDKRN.getFriendListPage({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getFriendListPage({ +OpenIMSDK.getFriendListPage({ offset, count, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx index 0d808dbad2..6852477a59 100644 --- a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx +++ b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx @@ -239,7 +239,7 @@ IMSDK.asyncApi('getSpecifiedFriendsInfo', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSpecifiedFriendsInfo({ +OpenIMSDK.getSpecifiedFriendsInfo({ friendUserIDList: string[]; filterBlack?: boolean; }, operationID?: string): Promise @@ -263,16 +263,16 @@ OpenIMSDKRN.getSpecifiedFriendsInfo({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const userIDList = ['userID1', 'userID2']; -OpenIMSDKRN.getSpecifiedFriendsInfo({ +OpenIMSDK.getSpecifiedFriendsInfo({ friendUserIDList: userIDList -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/refuseFriendApplication.mdx b/docs/sdks/api/relation/refuseFriendApplication.mdx index f3d1f4e570..ad778e8805 100644 --- a/docs/sdks/api/relation/refuseFriendApplication.mdx +++ b/docs/sdks/api/relation/refuseFriendApplication.mdx @@ -246,7 +246,7 @@ IMSDK.asyncApi('refuseFriendApplication', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.refuseFriendApplication({ +OpenIMSDK.refuseFriendApplication({ toUserID: string; handleMsg: string; }, operationID?: string): Promise @@ -271,16 +271,16 @@ OpenIMSDKRN.refuseFriendApplication({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.refuseFriendApplication({ +OpenIMSDK.refuseFriendApplication({ toUserID: '', handleMsg: '', -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/removeBlack.mdx b/docs/sdks/api/relation/removeBlack.mdx index e33b28c05d..d0530d9905 100644 --- a/docs/sdks/api/relation/removeBlack.mdx +++ b/docs/sdks/api/relation/removeBlack.mdx @@ -225,7 +225,7 @@ IMSDK.asyncApi('removeBlack', IMSDK.uuid(), 'userID') ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.removeBlack(userID: string, operationID?: string): Promise +OpenIMSDK.removeBlack(userID: string, operationID?: string): Promise ``` ### 输入参数 @@ -245,13 +245,13 @@ OpenIMSDKRN.removeBlack(userID: string, operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.removeBlack('userID', 'operationID') +OpenIMSDK.removeBlack('userID') .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/searchFriends.mdx b/docs/sdks/api/relation/searchFriends.mdx index 91544847fb..7f47a19b44 100644 --- a/docs/sdks/api/relation/searchFriends.mdx +++ b/docs/sdks/api/relation/searchFriends.mdx @@ -326,7 +326,7 @@ enum Relationship { type SearchedFriendsInfo = FriendUserItem & { relationship: Relationship; }; -OpenIMSDKRN.searchFriends({ +OpenIMSDK.searchFriends({ keywordList: string[]; isSearchUserID: boolean; isSearchNickname: boolean; @@ -355,18 +355,18 @@ OpenIMSDKRN.searchFriends({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.searchFriends({ - keywordList: ['nickname']; +OpenIMSDK.searchFriends({ + keywordList: ['nickname'], isSearchUserID: false, isSearchNickname: true, isSearchRemark: true, -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/relation/updateFriends.mdx b/docs/sdks/api/relation/updateFriends.mdx index bbf4f7f420..81a423748c 100644 --- a/docs/sdks/api/relation/updateFriends.mdx +++ b/docs/sdks/api/relation/updateFriends.mdx @@ -250,7 +250,7 @@ IMSDK.asyncApi('updateFriends', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.updateFriends({ +OpenIMSDK.updateFriends({ friendUserIDs: string[]; isPinned?: boolean; remark?: boolean; @@ -279,16 +279,16 @@ OpenIMSDKRN.updateFriends({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from 'open-im-sdk-rn'; +import OpenIMSDK from '@openim/rn-client-sdk'; -OpenIMSDKRN.updateFriends({ +OpenIMSDK.updateFriends({ friendUserIDs: ['userID'], remark: "new remark" -}, 'operationID') +}) .then((data) => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/third/logs.mdx b/docs/sdks/api/third/logs.mdx index 270a4daba9..fb6f9764dd 100644 --- a/docs/sdks/api/third/logs.mdx +++ b/docs/sdks/api/third/logs.mdx @@ -272,7 +272,7 @@ IMSDK.asyncApi('logs', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.logs({ +OpenIMSDK.logs({ logLevel: number, file: string, line: number, @@ -305,23 +305,24 @@ OpenIMSDKRN.logs({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.logs({ +OpenIMSDK.logs({ logLevel: 5, file: 'file', line: 10, msgs: 'msgs', err: 'err', keyAndValue: 'keyAndValue' -}, 'operationID') +}) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` + diff --git a/docs/sdks/api/third/setAppBadge.mdx b/docs/sdks/api/third/setAppBadge.mdx index 3a7ef03e21..8973f212b2 100644 --- a/docs/sdks/api/third/setAppBadge.mdx +++ b/docs/sdks/api/third/setAppBadge.mdx @@ -157,7 +157,7 @@ IMSDK.asyncApi('setAppBadge', IMSDK.uuid(), 99) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID?: string): Promise +OpenIMSDK.setAppBadge(appUnreadCount: number, operationID?: string): Promise ``` ### 输入参数 @@ -177,13 +177,13 @@ OpenIMSDKRN.setAppBadge(appUnreadCount: number, operationID?: string): Promise { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/third/updateFcmToken.mdx b/docs/sdks/api/third/updateFcmToken.mdx index eb173c275c..331ec31467 100644 --- a/docs/sdks/api/third/updateFcmToken.mdx +++ b/docs/sdks/api/third/updateFcmToken.mdx @@ -182,7 +182,7 @@ updateFcmToken(fcmToken, expireTime) .then(data => { // handle success }) - .catch(err => { + .catch((error) => { // handle failure }); ``` @@ -194,7 +194,7 @@ updateFcmToken(fcmToken, expireTime) ### Function Prototype ```ts showLineNumbers -OpenIMSDKRN.updateFcmToken(fcmToken: string, expireTime: number, operationID?: string): Promise; +OpenIMSDK.updateFcmToken(fcmToken: string, expireTime: number, operationID?: string): Promise; ``` ### Input Parameters @@ -208,7 +208,9 @@ OpenIMSDKRN.updateFcmToken(fcmToken: string, expireTime: number, operationID?: s ### Code Example ```ts showLineNumbers -updateFcmToken(fcmToken, expireTime) +import OpenIMSDK from "@openim/rn-client-sdk"; + +OpenIMSDK.updateFcmToken(fcmToken, expireTime) .then(data => { // handle success }) diff --git a/docs/sdks/api/third/uploadFile.mdx b/docs/sdks/api/third/uploadFile.mdx index ded6f12b00..e72409aaff 100644 --- a/docs/sdks/api/third/uploadFile.mdx +++ b/docs/sdks/api/third/uploadFile.mdx @@ -316,7 +316,7 @@ IMSDK.asyncApi('uploadFile', IMSDK.uuid(), { ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.uploadFile({ +OpenIMSDK.uploadFile({ name: string; contentType: string; uuid: string; @@ -344,18 +344,18 @@ OpenIMSDKRN.uploadFile({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.uploadFile({ +OpenIMSDK.uploadFile({ name: 'fileName.zip', contentType: 'zip', uuid: 'uuid', filepath: 'path://...', -}, 'operationID') +}) .then((data) => { // data: 文件远程链接 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/third/uploadLogs.mdx b/docs/sdks/api/third/uploadLogs.mdx index ef50c09cde..7a16cd9342 100644 --- a/docs/sdks/api/third/uploadLogs.mdx +++ b/docs/sdks/api/third/uploadLogs.mdx @@ -232,7 +232,7 @@ IMSDK.asyncApi('uploadLogs', IMSDK.uuid(), { line: 10000, ex: "" }) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.uploadLogs({ +OpenIMSDK.uploadLogs({ line: number, ex: string, }, operationID?: string): Promise @@ -257,13 +257,13 @@ OpenIMSDKRN.uploadLogs({ ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.uploadLogs({ line: 10000, ex: "" }, 'operationID') +OpenIMSDK.uploadLogs({ line: 10000, ex: "" }) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/getSelfUserInfo.mdx b/docs/sdks/api/user/getSelfUserInfo.mdx index 2b03d31701..27945ca8a0 100644 --- a/docs/sdks/api/user/getSelfUserInfo.mdx +++ b/docs/sdks/api/user/getSelfUserInfo.mdx @@ -205,7 +205,7 @@ IMSDK.asyncApi('getSelfUserInfo', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSelfUserInfo(operationID?: string): Promise +OpenIMSDK.getSelfUserInfo(operationID?: string): Promise ``` ### 输入参数 @@ -224,13 +224,13 @@ OpenIMSDKRN.getSelfUserInfo(operationID?: string): Promise ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.getSelfUserInfo('operationID') +OpenIMSDK.getSelfUserInfo() .then((data) => { // data: 当前登录用户的个人信息 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/getSubscribeUsersStatus.mdx b/docs/sdks/api/user/getSubscribeUsersStatus.mdx index 9724839ff5..6717096dc5 100644 --- a/docs/sdks/api/user/getSubscribeUsersStatus.mdx +++ b/docs/sdks/api/user/getSubscribeUsersStatus.mdx @@ -224,7 +224,7 @@ IMSDK.asyncApi('getSubscribeUsersStatus', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getSubscribeUsersStatus(operationID?: string): Promise +OpenIMSDK.getSubscribeUsersStatus(operationID?: string): Promise ``` ### 输入参数 @@ -243,13 +243,13 @@ OpenIMSDKRN.getSubscribeUsersStatus(operationID?: string): Promise { // data: 已订阅的用户在线状态详情列表 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/getUsersInfo.mdx b/docs/sdks/api/user/getUsersInfo.mdx index 2fcafe6197..b1636da186 100644 --- a/docs/sdks/api/user/getUsersInfo.mdx +++ b/docs/sdks/api/user/getUsersInfo.mdx @@ -231,7 +231,7 @@ IMSDK.asyncApi('getUsersInfo', IMSDK.uuid(), userIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.getUsersInfo(userIDList: string[], operationID?: string): Promise +OpenIMSDK.getUsersInfo(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -251,14 +251,14 @@ OpenIMSDKRN.getUsersInfo(userIDList: string[], operationID?: string): Promise { // data: 查询到的用户信息列表 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/setSelfInfo.mdx b/docs/sdks/api/user/setSelfInfo.mdx index 531a3bea3f..9873034b11 100644 --- a/docs/sdks/api/user/setSelfInfo.mdx +++ b/docs/sdks/api/user/setSelfInfo.mdx @@ -261,7 +261,7 @@ IMSDK.asyncApi('setSelfInfo', IMSDK.uuid(), userInfo) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.setSelfInfo( +OpenIMSDK.setSelfInfo( userInfo: Partial, operationID?: string ): Promise @@ -284,7 +284,7 @@ OpenIMSDKRN.setSelfInfo( ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const userInfo = { nickname: '', // 要修改的昵称，选填 @@ -292,11 +292,11 @@ const userInfo = { ex: '', // 要修改的扩展字段内容，选填 }; -OpenIMSDKRN.setSelfInfo(userInfo, 'operationID'); +OpenIMSDK.setSelfInfo(userInfo) .then(() => { // 调用成功 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/subscribeUsersStatus.mdx b/docs/sdks/api/user/subscribeUsersStatus.mdx index 89b92e9e2e..ea7aab831b 100644 --- a/docs/sdks/api/user/subscribeUsersStatus.mdx +++ b/docs/sdks/api/user/subscribeUsersStatus.mdx @@ -237,7 +237,7 @@ IMSDK.asyncApi('subscribeUsersStatus', IMSDK.uuid(), userIDList) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID?: string): Promise +OpenIMSDK.subscribeUsersStatus(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -257,14 +257,14 @@ OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID?: string): Pr ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; const userIDList = ['userID1', 'userID2']; -const data = await OpenIMSDKRN.subscribeUsersStatus(userIDList, 'operationID'); +OpenIMSDK.subscribeUsersStatus(userIDList) .then((data) => { // data: 用户在线状态详情列表 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` diff --git a/docs/sdks/api/user/unsubscribeUsersStatus.mdx b/docs/sdks/api/user/unsubscribeUsersStatus.mdx index 97fb0202ad..daddcafccc 100644 --- a/docs/sdks/api/user/unsubscribeUsersStatus.mdx +++ b/docs/sdks/api/user/unsubscribeUsersStatus.mdx @@ -230,7 +230,7 @@ IMSDK.asyncApi('unsubscribeUsersStatus', IMSDK.uuid()) ### 函数原型 ```ts showLineNumbers -OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID?: string): Promise +OpenIMSDK.unsubscribeUsersStatus(userIDList: string[], operationID?: string): Promise ``` ### 输入参数 @@ -250,13 +250,13 @@ OpenIMSDKRN.unsubscribeUsersStatus(userIDList: string[], operationID?: string): ### 代码示例 ```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +import OpenIMSDK from "@openim/rn-client-sdk"; -OpenIMSDKRN.unsubscribeUsersStatus(userIDList, 'operationID'); +OpenIMSDK.unsubscribeUsersStatus(userIDList) .then((data) => { // data: 用户在线状态详情列表 }) - .catch(({ errCode, errMsg }) => { + .catch((error) => { // 调用失败 }); ``` From 182a887a324c4321eebfbbb629e4cad88cdc8271 Mon Sep 17 00:00:00 2001 From: chan <1499188352@qq.com> Date: Mon, 3 Nov 2025 19:35:17 +0800 Subject: [PATCH 6/6] feat(rn-sdk): update getAdvancedHistoryMessageList and getAdvancedHistoryMessageListReverse --- docs/sdks/api/message/getAdvancedHistoryMessageList.mdx | 2 +- docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx index 2964d2d01b..077589c49f 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx @@ -289,7 +289,7 @@ OpenIMSDK.getAdvancedHistoryMessageList({ | conversationID | string | 是 | 会话 ID | | startClientMsgID | string | 是 | 起始的消息 clientMsgID，第一次拉取为""，后续为上一次拉取的最后一条消息的 clientMsgID | | count | number | 是 | 一次拉取的数量 | -| lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值，上下文，第二次拉取需要回传 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 判断为正常拉取聊天记录，还是搜索后获取消息上下文 | | operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果 diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx index a5e008278c..424440951c 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -282,7 +282,7 @@ OpenIMSDK.getAdvancedHistoryMessageListReverse({ | conversationID | string | 是 | 会话 ID | | startClientMsgID | string | 是 | 起始的消息 clientMsgID，第一次拉取为""，后续为上一次拉取的最后一条消息的 clientMsgID | | count | number | 是 | 一次拉取的数量 | -| lastMinSeq | number | 是 | lastMinSeq 是上一次拉取回调给的值，上下文，第二次拉取需要回传 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 判断为正常拉取聊天记录，还是搜索后获取消息上下文 | | operationID | string | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | ### 返回结果