From 0b3aada02785f92d4aeefdef0530c51addd2cf2d Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Tue, 24 Sep 2024 11:31:16 +0800 Subject: [PATCH 1/8] fix: remove the deleted method from the document --- .../class/relation/SetFriendRemarkParams.mdx | 35 -- .../current/api/conversation/index.mdx | 8 +- .../current/api/relation/index.mdx | 1 - .../current/api/relation/setFriendRemark.mdx | 324 ------------------ .../class/relation/SetFriendRemarkParams.mdx | 35 -- 5 files changed, 2 insertions(+), 401 deletions(-) delete mode 100644 docs/sdks/class/relation/SetFriendRemarkParams.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/setFriendRemark.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/SetFriendRemarkParams.mdx diff --git a/docs/sdks/class/relation/SetFriendRemarkParams.mdx b/docs/sdks/class/relation/SetFriendRemarkParams.mdx deleted file mode 100644 index 0b3abd2ae0..0000000000 --- a/docs/sdks/class/relation/SetFriendRemarkParams.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 5 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# SetFriendRemarkParams - -## 功能介绍 - -:::info - -好友备注参数 - -::: - - - - - -### SetFriendRemarkParams - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ----------------------- | -| ToUserID| string | 用户 ID | -|Remark| string| 备注 | - - - - diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/index.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/index.mdx index 369710b76b..170d24a7b6 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/index.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/index.mdx @@ -25,12 +25,8 @@ Related to Conversations | [getTotalUnreadMsgCount](/api/conversation/getTotalUnreadMsgCount.mdx) | Get the total count of unread messages | | [markConversationMessageAsRead](/api/conversation/markConversationMessageAsRead.mdx) | Clear the unread count for the conversation | | [setConversationDraft](/api/conversation/setConversationDraft.mdx) | Set a draft for the conversation | -| [pinConversation](/api/conversation/pinConversation.mdx) | Pin the conversation to the top | -| [setConversationRecvMessageOpt](/api/conversation/setConversationRecvMessageOpt.mdx) | Set do not disturb status for the conversation | -| [setConversationPrivateChat](/api/conversation/setConversationPrivateChat.mdx) | Enable or disable self-destructing messages | -| [setConversationBurnDuration](/api/conversation/setConversationBurnDuration.mdx) | Set self-destructing message destruction time | -| [resetConversationGroupAtType](/api/conversation/resetConversationGroupAtType.mdx) | Reset the @ flag | | [hideConversation](/api/conversation/hideConversation.mdx) | Hide the conversation | | [hideAllConversation](/api/conversation/hideAllConversation.mdx) | Hide all conversations | | [deleteConversationAndDeleteAllMsg](/api/conversation/deleteConversationAndDeleteAllMsg.mdx) | Delete conversation and its messages | -| [clearConversationAndDeleteAllMsg](/api/conversation/clearConversationAndDeleteAllMsg.mdx) | Delete messages in the conversation | \ No newline at end of file +| [clearConversationAndDeleteAllMsg](/api/conversation/clearConversationAndDeleteAllMsg.mdx) | Delete messages in the conversation | +| [setConversations](/api/conversation/setConversations.mdx) | set session information | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx index df78316570..510049874b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx @@ -21,7 +21,6 @@ SDK related to friends and blacklist. | [checkFriend](/api/relation/checkFriend.mdx) | Check if the other party is on your friend list | | [getFriendList](/api/relation/getFriendList.mdx) | Retrieve friend list | | [getSpecifiedFriendsInfo](/api/relation/getSpecifiedFriendsInfo.mdx) | Obtain specified friend information | -| [setFriendRemark](/api/relation/setFriendRemark.mdx) | Set friend remark | | [searchFriends](/api/relation/searchFriends.mdx) | Search for friends | | [deleteFriend](/api/relation/deleteFriend.mdx) | Remove a friend | | [getFriendApplicationListAsRecipient](/api/relation/getFriendApplicationListAsRecipient.mdx) | Get the friend application list | diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/setFriendRemark.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/setFriendRemark.mdx deleted file mode 100644 index 32730c0af6..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/setFriendRemark.mdx +++ /dev/null @@ -1,324 +0,0 @@ ---- -sidebar_position: 4 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setFriendRemark - -## Feature Introduction - -:::info Note - -Modify a friend's remark. - -::: - -:::caution Attention - -**Related callbacks**: -[onFriendInfoChanged](../../callback/onFriendInfoChanged) -[onConversationChanged](../../callback/onConversationChanged) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers - Future setFriendRemark({ - required String userID, - required String remark, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | --------- | ------------ | -| userID | String | Yes | User ID | -| remark | String | No | Remark to set. If empty, the remark will be removed. | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | -------------- | ------------------------------- | -| ~ | ~ | No exception means modification was successful. | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.friendshipManager.setFriendRemark( - userID: '1129', - remark: 'Tom', - ); - // todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setFriendRemark:(NSString *)userID - remark:(NSString * _Nullable)remark - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | --------- | ------------ | -| userID | NSString | Yes | User ID | -| remark | NSString | No | Remark to set. If empty, the remark will be removed. | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | ------------------------------ | ------------ | -| onSuccess | OIMSuccessCallback | Successful return. | -| onFailure | OIMFailureCallback | Failed return. | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager setFriendRemark:@"" - remark:@"" - onSuccess:^(NSString * _Nullable data) { -} onFailure:^(NSInteger code, NSString * _Nullable msg) { -}]; - -``` - - - - - -### Function Prototype - -```java showLineNumbers - - public void setFriendRemark(OnBase callBack, String uid, String remark) - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ------------------------ | --------- | ----------- | -| callBack | [OnBase](/callback/onBase.mdx) | Yes | Callback interface. | -| uid | String | Yes | User ID | -| remark | String | Yes | Remark | - -### Return Result - -### Code Example - -```java showLineNumbers - -OpenIMClient.getInstance().friendshipManager.setFriendRemark(new OnBase(){…},uid,remark) - -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setFriendRemark({ - toUserID: string; - remark: string; -}, operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | --------- | ------------ | -| toUserID | string | Yes | Friend's User ID | -| remark | string | Yes | Remark to set. If empty, the remark will be removed. | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | --------------------------------------------------- | --------------- | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback. | -| Promise.catch()| Promise<[WsResponse](/class/response.mdx)\> | Failed callback. | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.setFriendRemark({ - toUserID: '', - remark: '', -}) - .then(() => { - // Success - }) - .catch(({ errCode, errMsg }) => { - // Failure - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setFriendRemark', operationID: string, { - toUserID: string; - remark: string; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| --------------- | -------------- | --------- | ----------- | -| operationID | string | Yes | Operation ID for issue identification. Unique recommendation using current time and random number. | -| toUserID | string | Yes | Friend's User ID | -| remark | string | Yes | Remark to set. If empty, the remark will be removed. | - -### Return Result - -> The function is made Promise via the `openim-uniapp-polyfill` package. When calling, use `then` and `catch` to determine and handle success and failure callbacks. - -| Parameter Name | Parameter Type | Description | -| --------------- | ---------------------------------------------------- | --------------- | -| Promise.then() | Promise | Success callback. | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failed callback. | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('setFriendRemark', IMSDK.uuid(), { - toUserID: '', - remark: '', -}) - .then(() => { - // Success - }) - .catch(({ errCode, errMsg }) => { - // Failure - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setFriendRemark({ - toUserID: string; - remark: string; -}, operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| ----------- | -------- | -------- | ------------------------------------------------------- | -| toUserID | string | Yes | Friend's User ID | -| remark | string | Yes | Remark to set. If empty, the remark will be removed. | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -OpenIMSDKRN.setFriendRemark({ - toUserID: '', - remark: '', -}, 'operationID') - .then(() => { - // Success - }) - .catch(({ errCode, errMsg }) => { - // Failure - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers - -public static void SetFriendRemark(OnSucOrError cb, SetFriendRemarkParams userIDRemark) - -``` - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------- | --------------------------------------- | -------- | -------- | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) |Yes | Callback | -| userIDRemark |[SetFriendRemarkParams](/class/relation/SetFriendRemarkParams.mdx) |Yes | Remark Parameter | - -### Return Result - -### Code Example - -```C# showLineNumbers - -IMSDK.SetFriendRemark((suc,errCode,errMsg)=>{ - -},new SetFriendRemarkParams(){ - ToUserID = "userid", - Remark = "", -}) - -``` - - - - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/SetFriendRemarkParams.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/SetFriendRemarkParams.mdx deleted file mode 100644 index 2cc2f5b629..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/SetFriendRemarkParams.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 5 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# SetFriendRemarkParams - -## Feature Introduction - -:::info - -Friend Remark Parameter - -::: - - - - - -### SetFriendRemarkParams - -| Field Name | Data Type | Description | -| -------------- | -------- | -------------| -| ToUserID | string | User ID | -| Remark | string | Remark | - - - - From bd2dac93d68cddf08159d45572f5593b90e26eca Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Tue, 24 Sep 2024 12:22:08 +0800 Subject: [PATCH 2/8] fix: doc --- .../api/conversation/setConversations.mdx | 2 +- docs/sdks/api/relation/index.mdx | 3 +- docs/sdks/api/user/index.mdx | 2 +- .../setConversationPrivateChat.mdx | 327 ------------------ .../setConversationRecvMessageOpt.mdx | 317 ----------------- .../api/conversation/setConversations.mdx | 319 +++++++++++++++++ .../current/api/relation/index.mdx | 3 +- .../current/api/relation/updateFriends.mdx | 323 +++++++++++++++++ .../current/api/user/index.mdx | 2 - .../api/user/setGlobalRecvMessageOpt.mdx | 297 ---------------- .../current/api/user/setSelfInfo.mdx | 2 +- .../current/api/user/setSelfInfoEx.mdx | 325 ----------------- 12 files changed, 649 insertions(+), 1273 deletions(-) delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationPrivateChat.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationRecvMessageOpt.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setGlobalRecvMessageOpt.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfoEx.mdx diff --git a/docs/sdks/api/conversation/setConversations.mdx b/docs/sdks/api/conversation/setConversations.mdx index 714319de01..c6dead1cad 100644 --- a/docs/sdks/api/conversation/setConversations.mdx +++ b/docs/sdks/api/conversation/setConversations.mdx @@ -10,7 +10,7 @@ toc_max_heading_level: 2 :::info 说明 -设置回话信息。 +设置会话信息。 ::: diff --git a/docs/sdks/api/relation/index.mdx b/docs/sdks/api/relation/index.mdx index 48e819f4ec..e8fc08174d 100644 --- a/docs/sdks/api/relation/index.mdx +++ b/docs/sdks/api/relation/index.mdx @@ -30,4 +30,5 @@ toc_max_heading_level: 2 | [addBlack](docs/sdks/api/relation/addBlack.mdx) | 加入黑名单 | | [getBlackList](docs/sdks/api/relation/getBlackList.mdx) | 获取黑名单 | | [removeBlack](docs/sdks/api/relation/removeBlack.mdx) | 移除黑名单 | -| [getFriendListPage](docs/sdks/api/relation/getFriendListPage.mdx) | 分页获取自己指定数量好友的列表。 | \ No newline at end of file +| [getFriendListPage](docs/sdks/api/relation/getFriendListPage.mdx) | 分页获取自己指定数量好友的列表 | +| [updateFriends](docs/sdks/api/relation/updateFriends.mdx) | 修改好友信息 | \ No newline at end of file diff --git a/docs/sdks/api/user/index.mdx b/docs/sdks/api/user/index.mdx index 44bbc2c93f..7c01934bc7 100644 --- a/docs/sdks/api/user/index.mdx +++ b/docs/sdks/api/user/index.mdx @@ -18,7 +18,7 @@ toc_max_heading_level: 2 | ------------------------------------------------------------------------- | ------------------------ | | [setUserListener](docs/sdks/api/user/setUserListener.mdx) | 用户相关监听 | | [getSelfUserInfo](docs/sdks/api/user/getSelfUserInfo.mdx) | 获取自己的信息 | -| [setSelfInfo](docs/sdks/api/user/setSelfInfoEx.mdx) | 设置自己的信息 | +| [setSelfInfo](docs/sdks/api/user/setSelfInfo.mdx) | 设置自己的信息 | | [getUsersInfoWithCache](docs/sdks/api/user/getUsersInfoWithCache.mdx) | 获取相关用户信息 | | [subscribeUsersStatus](docs/sdks/api/user/subscribeUsersStatus.mdx) | 订阅用户的在线状态 | | [unsubscribeUsersStatus](docs/sdks/api/user/unsubscribeUsersStatus.mdx) | 取消订阅用户的在线状态 | diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationPrivateChat.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationPrivateChat.mdx deleted file mode 100644 index 97b52304ad..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationPrivateChat.mdx +++ /dev/null @@ -1,327 +0,0 @@ ---- -sidebar_position: 12 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setConversationPrivateChat - -## Feature Description - -:::info Description - -Activate or deactivate "read and burn." - -::: - -:::caution Note - -**Related Callback**: -[onConversationChanged](/callback/onConversationChanged.mdx) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers - Future setConversationPrivateChat({ - required String conversationID, - required bool isPrivate, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | -------- | ----------------- | -| conversationID | String | Yes | Conversation ID | -| isPrivate | bool | Yes | Activate read and burn | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | -------------------------- | -| ~ | ~ | Operation is successful if no exception is thrown | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.setConversationPrivateChat(conversationID: conversationID, isPrivate: isPrivate); - //todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setConversationPrivateChat:(NSString *)conversationID - isPrivate:(BOOL)isPrivate - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | -------- | ----------------- | -| conversationID | NSString | Yes | Conversation ID | -| isPrivate | BOOL | Yes | Activate read and burn | - -### Return Result - -| Name | Type | Description | -| ---------- | ------------------- | ------------ | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager setConversationPrivateChat:@"" - isPrivate:YES - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { - -}]; - -``` - - - - - -### Function Prototype - -```java showLineNumbers - public void setOneConversationPrivateChat(OnBase base, String conversionID, boolean isPrivate) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------- | -------- | ------------- | -| base | [OnBase](/callback/onBase.mdx) | Yes | Callback interface | -| conversationID | String | Yes | Conversation ID | -| isPrivate | bool | Yes | Private chat | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | -------------------------- | -| ~ | ~ | Operation is successful if no exception is thrown | - -### Code Example - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.setOneConversationPrivateChat(new OnBase() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(String data) { - - } - }conversionID,isPrivate); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setConversationPrivateChat({ - conversationID: string; - isPrivate: boolean; -},operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | -------- | ----------------------- | -| conversationID | string | Yes | Conversation ID | -| isPrivate | boolean | Yes | Activate read and burn | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | ------------------------------------------------ | ----------------- | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.setConversationPrivateChat({ - conversationID: 'conversationID', - isPrivate: true, -}) - .then(({ data }) => { - // Call was successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setConversationPrivateChat', operationID: string, { - conversationID: string; - isPrivate: boolean; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------------- | -------- | ------------------------------------------------------------ | -| operationID | string | Yes | Operation ID, used for problem tracking, keep unique, recommended to use current time and random number | -| conversationID | string | Yes | Conversation ID | -| isPrivate | boolean | Yes | Activate read and burn | - -### Return Result - -> The function is Promise-wrapped through the `openim-uniapp-polyfill` package. When calling, you need to use `then` and `catch` to determine and handle success and failure callbacks respectively. - -| Parameter Name | Parameter Type | Description | -| -------------- | --------------------------------------------------- | ----------------- | -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('setConversationPrivateChat', IMSDK.uuid(), { - conversationID: 'conversationID', - isPrivate: true, -}) - .then(() => { - // Call was successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setConversationPrivateChat({ - conversationID: string, - isPrivate: boolean, -}, operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| conversationID | string | Yes | Conversation ID | -| isPrivate | boolean | Yes | Activate read and burn | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -OpenIMSDKRN.setConversationPrivateChat({ - conversationID: 'conversationID', - isPrivate: true, -}, 'operationID') - .then(() => { - // Call was successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers -public static void SetConversationPrivateChat(OnSucOrError cb, string conversationID, bool isPrivate) -``` - - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ------------------------------------------------ | -------- | ---------- | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) | Yes | Callback | -| conversationID | string | Yes | Conversation ID | -| isPrivate | bool | Yes | Activate read and burn | - -### Return Result - -### Code Example - -```C# showLineNumbers -IMSDK.SetConversationPrivateChat((suc,errCode,errMsg)=>{ - -} conversionID,isPrivate); -``` - - - - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationRecvMessageOpt.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationRecvMessageOpt.mdx deleted file mode 100644 index 32eaedbb81..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationRecvMessageOpt.mdx +++ /dev/null @@ -1,317 +0,0 @@ ---- -sidebar_position: 11 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setConversationRecvMessageOpt - -## Feature Introduction - -:::info Description - -Set conversation "Do Not Disturb" status. - -::: - -:::caution Note - -**Related Callback**: -[onConversationChanged](/callback/onConversationChanged.mdx) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers - Future setConversationRecvMessageOpt({ - required String conversationID, - required int status, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| --------------------| --------------------| ---------| -------------------------------------------------------------------------- | -| conversationID | String | Yes | Conversation ID | -| status | [int](/enum/recvMsgOpt.mdx) | Yes | Message Do Not Disturb status 0: Normal; 1: Don't receive messages; 2: Receive online messages but not offline messages | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | ----------------------------| -| ~ | ~ | Operation successful if no exception thrown | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.setConversationRecvMessageOpt(conversationIDList: conversationIDList, status: status); - //todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setConversationRecvMessageOpt:(NSString *)conversationID - status:(OIMReceiveMessageOpt)status - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| ---------------| ----------------------------------------------------| ---------| ------------------| -| conversationID | NSString | Yes | Conversation ID | -| status | [OIMReceiveMessageOpt](/enum/recvMsgOpt.mdx) | Yes | Message Do Not Disturb status | - -### Return Result - -| Name | Type | Description | -| ----------| -------------------------| --------------| -| onSuccess | OIMSuccessCallback | Success return| -| onFailure | OIMFailureCallback | Failure return| - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager setConversationRecvMessageOpt:@"" - status: - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { - -}]; - -``` - - - - - -### Function Prototype - -```java showLineNumbers - public void setConversationRecvMessageOpt(OnBase base, List conversationIDs, long status) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| ----------------| -------------------------------------------------| ---------| --------------------------------------------------------------------------| -| base | [OnBase](/callback/onBase.mdx) | Yes | Callback interface | -| conversationIDs | List | Yes | List of Conversation IDs | -| status | int | Yes | [Opt](/enum/recvMsgOpt.mdx) Message Receive Status | - -### Code Example - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.setConversationRecvMessageOpt(new OnBase() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(String data) { - - } - }conversationIDs,status); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setConversationRecvMessageOpt({ - conversationID: string; - opt: MessageReceiveOptType; -},operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| ---------------| --------------------------------------------------------| ---------| ------------------| -| conversationID | string | Yes | Conversation ID | -| opt | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Message Do Not Disturb status | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | -----------------------------------------------------| ----------------------| -| Promise.then() | Promise<[WsResponse](/class/response.mdx)> | Success callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.setConversationRecvMessageOpt({ - conversationID: 'conversationID', - opt: 2, -}) - .then(({ data }) => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setConversationRecvMessageOpt', operationID: string, { - conversationID: string; - opt: MessageReceiveOptType; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| ---------------| --------------------------------------------------------| ---------| ----------------------------------------------------------------------| -| operationID | string | Yes | Operation ID, used for problem tracking, should be unique. It's recommended to use the current time combined with a random number | -| opt | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Message Do Not Disturb status | - -### Return Result - -> The function is made Promise compatible through the `openim-uniapp-polyfill` package. When calling, use `then` and `catch` to determine and handle the success and failure callbacks. - -| Parameter Name | Parameter Type | Description | -| --------------- | --------------------------------------------------------| ----------------------| -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)> | Failure callback | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('setConversationRecvMessageOpt', IMSDK.uuid(), { - conversationID: 'conversationID', - opt: 2, -}) - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setConversationRecvMessageOpt({ - conversationID: string, - opt: number, -}, operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | -| opt | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Message Do Not Disturb status | -|conversationID| string |Yes |message ID| -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -OpenIMSDKRN.setConversationRecvMessageOpt({ - conversationID: 'conversationID', - opt: 2, -}, 'operationID') - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers -public static void SetConversationRecvMessageOpt(OnSucOrError cb, string conversationID, int opt) -``` - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| --------------- | ------------------------------------------------ | -------- | ------------------------------------------------------------------ | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) | Yes | Callback | -| conversationID | string | Yes | Conversation ID | -| opt | int | Yes | [Opt](/enum/recvMsgOpt.mdx) Message Do Not Disturb status | - -### Code Example - -```C# showLineNumbers -IMSDK.SetConversationRecvMessageOpt((suc,errCode,errMsg)=>{ - -},conversationIDs,status); -``` - - - - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx new file mode 100644 index 0000000000..640a87d10d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx @@ -0,0 +1,319 @@ +--- +sidebar_position: 10 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# setConversations + +## Feature Introduction + +:::info Description + +Set session information. + +::: + +:::caution Note + +**Related Callback**: +[onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) + +::: + + + + + +### Function Prototype + +```dart showLineNumbers +Future pinConversation({ + required String conversationID, + required bool isPinned, + String? operationID, + }) +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | -------- | -------- | -------- | +| conversationID | String | Yes | conversation id | +| isPinned | bool | Yes | is it pinned | + +### Return Result + +| Name | Type | Description | +| ---- | ---- | -------------------- | +| ~ | ~ | Successful if no exception thrown | + +### Code Example + +```dart showLineNumbers + await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned); + //todo +``` + + + + + +### Function Prototype + +```swift showLineNumbers + +- (void)pinConversation:(NSString *)conversationID + isPinned:(BOOL)isPinned + onSuccess:(nullable OIMSuccessCallback)onSuccess + onFailure:(nullable OIMFailureCallback)onFailure; + +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | -------- | -------- | -------- | +| conversationID | NSString | Yes | conversation id | +| isPinned | BOOL | Yes | is it pinned | + +### Return Result + +| 名称 | 类型 | Description | +| --------- | ------------------------------------------------------ | -------- | +| onSuccess | OIMSuccessCallback | Successful return | +| onFailure | OIMFailureCallback | Failure return | + +### Code Example + +```swift showLineNumbers + +[OIMManager.manager pinConversation:@"" + isPinned:YES + onSuccess:^(NSString * _Nullable data) { + +} onFailure:^(NSInteger code, NSString * _Nullable msg) { + +}]; + +``` + + + + + +### Function Prototype + +```java showLineNumbers +public void pinConversation(OnBase callBack, String conversationID, boolean isPinned) +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | ------------------------------------------------ | -------- | -------- | +| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | Yes | Callback interface | +| conversationID | String | Yes | conversation id | +| isPinned | bool | Yes | is it pinned | + +### Code Example + +```java showLineNumbers + OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase() { + @Override + public void onError(int code, String error) { + + } + + @Override + public void onSuccess(String data) { + + } + },conversationID,isPinned); +``` + + + + + +### Function Prototype + +```ts showLineNumbers +IMSDK.pinConversation({ + conversationID: string; + isPinned: boolean; +},operationID?: string): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | -------- | -------- | -------- | +| conversationID | string | Yes | conversation id | +| isPinned | boolean | Yes | is it pinned | + +### Return Result + +| Parameter Name | Data Type | Description | +| --------------- | ---------------------------------------------------- | ------------ | +| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Success callback | +| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Failure callback | + +### Code Example + +```js showLineNumbers +import { getSDK } from 'open-im-sdk-wasm'; +const IMSDK = getSDK(); + +// use in electron with ffi +// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; +// const { instance: IMSDK } = getWithRenderProcess(); + +// use in mini program +// import { OpenIMSDK } from 'open-im-sdk'; +// const IMSDK = new OpenIMSDK(); + +IMSDK.pinConversation({ + conversationID: 'conversationID', + isPinned: true, +}) + .then(({ data }) => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + + +### Function Prototype + +```ts showLineNumbers +IMSDK.asyncApi('pinConversation', operationID: string, { + conversationID: string; + isPinned: boolean; +}): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | -------- | -------- | ------------------------------------------------------- | +| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | +| conversationID | string | Yes | conversation id | +| isPinned | boolean | Yes | is it pinned | + +### Return Result + +> Use the `openim-uniapp-polyfill` package to convert the function into a Promise. When calling, you need to use `then` and `catch` to judge and handle the success and failure callbacks. + +| Parameter Name | Data Type | Description | +| --------------- | ------------------------------------------------------- | ------------ | +| Promise.then() | Promise | Success callback | +| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Failure callback | + +### Code Example + +```js showLineNumbers +import IMSDK from 'openim-uniapp-polyfill'; + +IMSDK.asyncApi('pinConversation', IMSDK.uuid(), { + conversationID: 'conversationID', + isPinned: true, +}) + .then(() => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + +### Function Prototype + +```ts showLineNumbers +OpenIMSDKRN.pinConversation({ + conversationID: string, + isPinned: boolean, +},operationID: string): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | -------- | -------- | ------------------------------------------------------- | +| conversationID | string | Yes | conversation id | +| isPinned | boolean | Yes | is it pinned | +| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | + +### Return Result + +| Parameter Name | Data Type | Description | +| --------------- | ------------------------------------------------------- | ------------ | +| Promise.then() | Promise | Success callback | +| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Failure callback | + +### Code Example + +```js showLineNumbers +import OpenIMSDKRN from "open-im-sdk-rn"; + +OpenIMSDKRN.pinConversation({ + conversationID: 'conversationID', + isPinned: true, +}, 'operationID') + .then(() => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + + +### Function Prototype + +```C# showLineNumbers +public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned) +``` + + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------------- | ------------------------------------------------ | -------- | -------- | +| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | Yes | Callback interface | +| conversationID | string | Yes | conversation id | +| isPinned | bool | Yes | is it pinned | + +### Code Example + +```C# showLineNumbers +IMSDK.((suc,errCode,errMsg)=>{ + +},conversationID,isPinned); +``` + + + + diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx index 510049874b..81be944778 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx @@ -29,4 +29,5 @@ SDK related to friends and blacklist. | [refuseFriendApplication](/api/relation/refuseFriendApplication.mdx) | Decline friend application | | [addBlack](/api/relation/addBlack.mdx) | Add to blacklist | | [getBlackList](/api/relation/getBlackList.mdx) | Retrieve blacklist | -| [removeBlack](/api/relation/removeBlack.mdx) | Remove from blacklist | \ No newline at end of file +| [removeBlack](/api/relation/removeBlack.mdx) | Remove from blacklist | +| [updateFriends](/api/relation/updateFriends) | Modify friend information | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx new file mode 100644 index 0000000000..5132eab392 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx @@ -0,0 +1,323 @@ +--- +sidebar_position: 4 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# updateFriends + +## Feature Introduction + +:::info Description + +Modify friend information, including pinning, notes, and ex fields. + +::: + +:::caution Note + +**Related Callback**: +[onFriendInfoChanged](../../callback/onFriendInfoChanged) +[onConversationChanged](../../callback/onConversationChanged) + +::: + + + + + +### Function Prototype + +```dart showLineNumbers + Future updateFriends({ + required String userID, + required String remark, + String? operationID, + }) +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------- | -------- | -------- | ------- | +| userID | String | Yes | user id | +| remark | String | No | set remark | + +### Return Result + +| Parameter Name | Data Type | Description | +| -------- | -------- | -------------------- | +| ~ | ~ | If no exception is thrown, the modification is successful | + +### Code Example + +```dart showLineNumbers + await OpenIM.iMManager.friendshipManager.updateFriends( + userID: '1129', + remark: 'Tom', + ); + // todo +``` + + + + + +### Function Prototype + +```swift showLineNumbers + +- (void)updateFriends:(NSString *)userID + remark:(NSString * _Nullable)remark + onSuccess:(nullable OIMSuccessCallback)onSuccess + onFailure:(nullable OIMFailureCallback)onFailure; + +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------- | -------- | -------- | ------- | +| userID | NSString | Yes | user id | +| remark | NSString | No | set remark | + +### Return Result + +| Parameter Name | Data Type | Description | +| --------- | ------------------------------------------------------ | -------- | +| onSuccess | OIMSuccessCallback | Successful return | +| onFailure | OIMFailureCallback | Failure return | + +### Code Example + +```swift showLineNumbers + +[OIMManager.manager updateFriends:@"" + remark:@"" + onSuccess:^(NSString * _Nullable data) { +} onFailure:^(NSInteger code, NSString * _Nullable msg) { +}]; + +``` + + + + + +### Function Prototype + +```java showLineNumbers + + public void updateFriends(OnBase callBack, String uid, String remark) + +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------- | --------------------------------------- | -------- | -------- | +| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | Yes | Callback interface | +| uid | String | Yes | user id | +| remark | String | Yes | remark | + +### Return Result + +### Code Example + +```java showLineNumbers + +OpenIMClient.getInstance().friendshipManager.updateFriends(new OnBase(){…},uid,remark) + +``` + + + + + +### Function Prototype + +```ts showLineNumbers +IMSDK.updateFriends({ + toUserID: string; + remark: string; +}, operationID?: string): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------- | -------- | -------- | ------------------------------------ | +| toUserID | string | Yes | friend user id | +| remark | string | Yes | set remark | + +### Return Result + +| Parameter Name | Data Type | Description | +| --------------- | ---------------------------------------------------- | ------------ | +| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Call success | +| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Call failed | + +### Code Example + +```js showLineNumbers +import { getSDK } from 'open-im-sdk-wasm'; +const IMSDK = getSDK(); + +// use in electron with ffi +// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; +// const { instance: IMSDK } = getWithRenderProcess(); + +// use in mini program +// import { OpenIMSDK } from 'open-im-sdk'; +// const IMSDK = new OpenIMSDK(); + +IMSDK.updateFriends({ + toUserID: '', + remark: '', +}) + .then(() => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + + +### Function Prototype + +```ts showLineNumbers +IMSDK.asyncApi('updateFriends', operationID: string, { + toUserID: string; + remark: string; +}): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| ----------- | -------- | -------- | ------------------------------------------------------- | +| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | +| toUserID | string | Yes | friend user id | +| remark | string | Yes | set remark | + +### Return Result + +> Use the `openim-uniapp-polyfill` package to convert the function into a Promise. When calling, you need to use `then` and `catch` to judge and handle the success and failure callbacks. + +| Parameter Name | Data Type | Description | +| --------------- | ------------------------------------------------------- | ------------ | +| Promise.then() | Promise | Call success | +| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Call failed | + +### Code Example + +```js showLineNumbers +import IMSDK from 'openim-uniapp-polyfill'; + +IMSDK.asyncApi('updateFriends', IMSDK.uuid(), { + toUserID: '', + remark: '', +}) + .then(() => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + +### Function Prototype + +```ts showLineNumbers +OpenIMSDKRN.updateFriends({ + toUserID: string; + remark: string; +}, operationID: string): Promise +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| ----------- | -------- | -------- | ------------------------------------------------------- | +| toUserID | string | Yes | friend user id | +| remark | string | Yes | set remark | +| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | + +### Return Result + +| Parameter Name | Data Type | Description | +| --------------- | ------------------------------------------------------- | ------------ | +| Promise.then() | Promise | Call success | +| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Call failed | + +### Code Example + +```js showLineNumbers +import OpenIMSDKRN from "open-im-sdk-rn"; + +OpenIMSDKRN.updateFriends({ + toUserID: '', + remark: '', +}, 'operationID') + .then(() => { + // Call success + }) + .catch(({ errCode, errMsg }) => { + // Call failed + }); +``` + + + + + +### Function Prototype + +```C# showLineNumbers + +public static void UpdateFriends(OnSucOrError cb, UpdateFriendsParams userIDRemark) + +``` + +### Input Parameters + +| Parameter Name | Data Type | Mandatory | Description | +| -------- | --------------------------------------- | -------- | -------- | +| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | Yes | Callback interface | +| userIDRemark |[UpdateFriendsParams](docs/sdks/class/relation/UpdateFriendsParams.mdx) | Yes | Setting parameters | + +### Return Result + +### Code Example + +```C# showLineNumbers + +IMSDK.UpdateFriends((suc,errCode,errMsg)=>{ + +},new UpdateFriendsParams(){ + ToUserID = "userid", + Remark = "", +}) + +``` + + + diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/index.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/index.mdx index e70f51e710..7868f4968c 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/index.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/index.mdx @@ -20,11 +20,9 @@ User information related SDK | [setUserListener](/api/user/setUserListener.mdx) | User-related Listener | | [getSelfUserInfo](/api/user/getSelfUserInfo.mdx) | Retrieve own information | | [setSelfInfo](/api/user/setSelfInfo.mdx) | Set own information(Deprecated) | -| [setSelfInfoEx](/api/user/setSelfInfoEx.mdx) | Set own information | | [getUsersInfoWithCache](/api/user/getUsersInfoWithCache.mdx) | Retrieve relevant user information | | [subscribeUsersStatus](/api/user/subscribeUsersStatus.mdx) | Subscribe to user's online status | | [unsubscribeUsersStatus](/api/user/unsubscribeUsersStatus.mdx) | Unsubscribe from user's online status | | [getSubscribeUsersStatus](/api/user/getSubscribeUsersStatus.mdx)| Retrieve subscribed user's online status | | [setAppBackgroundStatus](/api/user/setAppBackgroundStatus.mdx) | Set whether the APP is in the background | | [networkStatusChanged](/api/user/networkStatusChanged.mdx) | Client network has changed | -| [setGlobalRecvMessageOpt](/api/user/setGlobalRecvMessageOpt.mdx)| Set global message notification preferences | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setGlobalRecvMessageOpt.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setGlobalRecvMessageOpt.mdx deleted file mode 100644 index eb0bf9d979..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setGlobalRecvMessageOpt.mdx +++ /dev/null @@ -1,297 +0,0 @@ ---- - -sidebar_position: 10 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setGlobalRecvMessageOpt - -## Function Introduction - -:::info Description - -Globally set message notifications. Can be used to turn off global message notifications, including offline push and sound alerts. - -::: - -:::caution Note - -::: - - - - - -### Function Prototype - -```dart showLineNumbers - Future setGlobalRecvMessageOpt({ - required int status, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| -------------- | ---------------------------------- | -------- | ---------------------------------------------------------------------------------------- | -| status | [int](/enum/recvMsgOpt.mdx) | Yes | Disturbance mode 0: Normal; 1: Don't receive messages; 2: Receive online messages but not offline messages | - -### Return Results - -| Name | Type | Description | -| ---- | ---- | -------------------------- | -| ~ | ~ | Operation successful if no exceptions are thrown | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.setGlobalRecvMessageOpt(status: 0); - // todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setGlobalRecvMessageOpt:(OIMReceiveMessageOpt)opt - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| -------------- | --------------------------------------- | -------- | -------------------| -| opt | [OIMReceiveMessageOpt](/enum/recvMsgOpt.mdx) | Yes | Disturbance mode | - -### Return Results - -| Name | Type | Description | -| --------- | -----------------| -------------- | -| onSuccess | OIMSuccessCallback | Successful return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager setGlobalRecvMessageOpt:OIMReceiveMessageOptNotReceive - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { - -}]; - -``` - - - - - -### Function Prototype - -```dart showLineNumbers - public void setGlobalRecvMessageOpt(OnBase base, long status) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| -------------- | ----------------| -------- | ----------------------------------------------------------------| -| base | OnBase | Yes | Callback interface | -| status | int | Yes | [MessageOpt](/enum/recvMsgOpt.mdx) Conversation message reception option| - -### Code Example - -```dart showLineNumbers - OpenIMClient.getInstance().conversationManager.setGlobalRecvMessageOpt(new OnBase() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(String data) { - - } - },status); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setGlobalRecvMessageOpt(data: MessageReceiveOptType, operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| -------------- | ----------------------------------------| -------- | -----------------| -| data | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Disturbance mode | - -### Return Results - -| Parameter Name | Parameter Type | Description | -| --------------- | ---------------------------------------- | ---------------- | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Successful callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify) - .then(({ data }) => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setGlobalRecvMessageOpt', operationID: string, data: MessageReceiveOptType): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Required | Description | -| -------------- | ---------------------------------------------------- | -------- | ------------------------------------------------------------------------------ | -| operationID | string | Yes | Operation ID, used for issue localization, keep unique, suggested to use current time and random number | -| data | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Do Not Disturb status | - -### Return Results - -> Through the `openim-uniapp-polyfill` package, the function is Promisified. You need to use `then` and `catch` to determine and handle the successful and failed callbacks. - -| Parameter Name | Parameter Type | Description | -| ---------------- | --------------------------------------------------- | ------------------- | -| Promise.then() | Promise | Successful callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failed callback | - -### Code Example - -```js showLineNumbers -import IMSDK, { MessageReceiveOptType } from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi( - 'setGlobalRecvMessageOpt', - IMSDK.uuid(), - MessageReceiveOptType.NotNotify -) - .then(({ data }) => { - // Successfully called - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setGlobalRecvMessageOpt( - opt: MessageReceiveOptType, - operationID: string -): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| ----------- | ------------------------------------------------------ | -------- | ------------------------------------------------------- | -| data | [MessageReceiveOptType](/enum/recvMsgOpt.mdx) | Yes | Do Not Disturb status | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN, { MessageReceiveOptType } from "open-im-sdk-rn"; - -OpenIMSDKRN.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify, operationID) - .then(({ data }) => { - // Successfully called - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers -public static void SetGlobalRecvMessageOpt(OnSucOrError cb, int opt) -``` - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------- | --------------- | -------- | ------------------------------------------------------- | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) |Yes | Callback | -| opt | int |Yes | [MessageOpt](/enum/recvMsgOpt.mdx) Receive Option| - -### Code Example - -```C# showLineNumbers - -IMSDK.SetGlobalRecvMessageOpt((suc,errCode,errMsg)=>{ - -},opt); - -``` - - - - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfo.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfo.mdx index 1b311cc8a9..cd50264d8d 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfo.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfo.mdx @@ -10,7 +10,7 @@ toc_max_heading_level: 2 :::info Description -Allows logged-in users to modify their own avatar and nickname.(This interface is deprecated. Please use `setSelfInfoEx`) +Allows logged-in users to modify their own avatar and nickname. ::: diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfoEx.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfoEx.mdx deleted file mode 100644 index a4a60c1df0..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/setSelfInfoEx.mdx +++ /dev/null @@ -1,325 +0,0 @@ ---- -sidebar_position: 3 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setSelfInfoEx - -## Feature Introduction - -:::info Description - -Allows logged-in users to modify their own avatar and nickname. - -::: - -:::caution Note - -**Related Callback**: -[onSelfInfoUpdated](/callback/onSelfUserInfoUpdate.mdx) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers - Future setSelfInfo({ - String? nickname, - String? faceURL, - int? appMangerLevel, - String? ex, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| --------------- | -------------- | --------- | ---------------- | -| nickname | String? | No | User nickname | -| faceURL | String? | No | User avatar | -| appMangerLevel | int? | No | Internal field, can be ignored | -| ex | String? | No | Extension information | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | -------------- | ------------------------------ | -| ~ | ~ | If no exception is thrown, the modification is successful | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.userManager.setSelfInfo( - nickname: 'lucy', - ); - // todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setSelfInfo:(OIMUserInfo *)userInfo - onSuccess:(OIMSuccessCallback)onSuccess - onFailure:(OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ---------------------------------------- | --------- | ----------------- | -| userInfo | [OIMUserInfo](/class/user/userInfo.mdx) | Yes | User-related information | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | -------------------- | ------------ | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -OIMUserInfo *info = [OIMUserInfo new]; -info.nickname = @""; -info.faceURL = @""; - -[OIMManager.manager setSelfInfo:info - onSuccess:^(NSString * _Nullable data) { -} onFailure:^(NSInteger code, NSString * _Nullable msg) { -}]; - -``` - - - - - -### Function Prototype - -```java showLineNumbers - - public void setSelfInfo(OnBase callBack, String nickname, String faceURL, int appMangerLevel, String ex) - -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| --------------- | ------------------------------------ | --------- | ------------------------------------ | -| callBack | [OnBase](/callback/onBase.mdx) | Yes | Callback interface | -| nickname | String | Yes | Name | -| faceURL | String | Yes | Avatar | -| gender | int | Yes | Gender 1: Male, 2: Female | -| appMangerLevel | int | Yes | Internal field, can be ignored | -| ex | String | No | Extension field | - -### Return Result - -### Code Example - -```java showLineNumbers - -OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase(){…},...); - -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setSelfInfo(userInfo: Partial>, operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------------- | --------- | ----------- | -| userInfo | Partial> | Yes | Personal information | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| -------------- | -------------------------------------- | ------------------- | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | -| Promise.catch()| Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -const userInfo = { - nickname: '', // Desired nickname, optional - faceURL: '', // Desired avatar, optional - ex: '', // Desired extension field content, optional -}; -IMSDK.setSelfInfo(userInfo) - .then(() => { - // Call successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setSelfInfo', operationID: string, userInfo: Partial>): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------------- | --------- | ----------------------------------------------------------- | -| operationID | string | Yes | Operation ID used for troubleshooting, keep unique. It is recommended to use the current time combined with a random number | -| userInfo | Partial> | Yes | Personal information | - -### Return Result - -> The function is made Promise-based through the `openim-uniapp-polyfill` package. When calling, use `then` and `catch` to determine and handle the success and failure callbacks. - -| Parameter Name | Parameter Type | Description | -| -------------- | ----------------------------------------------- | ------------------- | -| Promise.then() | Promise | Success callback | -| Promise.catch()| Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -const userInfo = { - nickname: '', // Desired nickname, optional - faceURL: '', // Desired avatar, optional - ex: '', // Desired extension field content, optional -}; -IMSDK.asyncApi('setSelfInfo', IMSDK.uuid(), userInfo) - .then(() => { - // Call successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setSelfInfo( - userInfo: Partial>, // Replace with the actual structure of userInfo - operationID: string -); -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| ----------- | -------------------------------------------------------------------------- | -------- | ------------------------------------------------------- | -| userInfo | Partial> | Yes | Personal information | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -const userInfo = { - nickname: '', // Desired nickname, optional - faceURL: '', // Desired avatar, optional - ex: '', // Desired extension field content, optional -}; - -OpenIMSDKRN.setSelfInfo(userInfo, 'operationID'); - .then(() => { - // Call successful - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers - -public static void SetSelfInfo(OnSucOrError cb, UserInfo userInfo); - -``` - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | --------------------------------------- | -------- | ------------------------------ | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) |Yes | Callback | -| userInfo | [UserInfo](/class/user/userInfo.mdx) |Yes | Personal information | - -### Return Result - -### Code Example - -```C# showLineNumbers - -IMSDK.SetSelfInfo((suc,errCode,errMsg)=>{ - -},userInfo); - -``` - - - - \ No newline at end of file From 001f4b4487974e7ecd54cecaae49359891e2b768 Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Tue, 24 Sep 2024 12:25:10 +0800 Subject: [PATCH 3/8] fix: doc en path --- .../current/api/conversation/setConversations.mdx | 8 ++++---- .../current/api/relation/updateFriends.mdx | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx index 640a87d10d..c4c038d0e4 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx @@ -167,8 +167,8 @@ IMSDK.pinConversation({ | Parameter Name | Data Type | Description | | --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Success callback | -| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Failure callback | +| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | +| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | ### Code Example @@ -224,7 +224,7 @@ IMSDK.asyncApi('pinConversation', operationID: string, { | Parameter Name | Data Type | Description | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Failure callback | +| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | ### Code Example @@ -268,7 +268,7 @@ OpenIMSDKRN.pinConversation({ | Parameter Name | Data Type | Description | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Failure callback | +| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | ### Code Example diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx index 5132eab392..27aa08c58e 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx @@ -165,8 +165,8 @@ IMSDK.updateFriends({ | Parameter Name | Data Type | Description | | --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Call success | -| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | Call failed | +| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Call success | +| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Call failed | ### Code Example @@ -222,7 +222,7 @@ IMSDK.asyncApi('updateFriends', operationID: string, { | Parameter Name | Data Type | Description | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | Call success | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Call failed | +| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Call failed | ### Code Example @@ -266,7 +266,7 @@ OpenIMSDKRN.updateFriends({ | Parameter Name | Data Type | Description | | --------------- | ------------------------------------------------------- | ------------ | | Promise.then() | Promise | Call success | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | Call failed | +| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Call failed | ### Code Example From 47f2dfcc9154edcdb6f32e60d8308ae1f187e892 Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Tue, 24 Sep 2024 12:34:47 +0800 Subject: [PATCH 4/8] fix: doc en path --- .../api/conversation/pinConversation.mdx | 323 ------------------ .../setConversationBurnDuration.mdx | 317 ----------------- 2 files changed, 640 deletions(-) delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/pinConversation.mdx delete mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationBurnDuration.mdx diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/pinConversation.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/pinConversation.mdx deleted file mode 100644 index d64afcee56..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/pinConversation.mdx +++ /dev/null @@ -1,323 +0,0 @@ ---- - -sidebar_position: 10 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# pinConversation - -## Feature Introduction - -:::info Description - -Pin or unpin a conversation. - -::: - -:::caution Note - -**Related Callback**: -[onConversationChanged](/callback/onConversationChanged.mdx) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers -Future pinConversation({ - required String conversationID, - required bool isPinned, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------- | -| conversationID | String | Yes | Conversation ID | -| isPinned | bool | Yes | Pin status | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | ---------------------- | -| ~ | ~ | Successful if no exception thrown | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned); - //todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)pinConversation:(NSString *)conversationID - isPinned:(BOOL)isPinned - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------- | -| conversationID | NSString | Yes | Conversation ID | -| isPinned | BOOL | Yes | Pin status | - -### Return Result - -| Name | Type | Description | -| --------- | ------------------- | ------------- | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager pinConversation:@"" - isPinned:YES - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { - -}]; - -``` - - - - - -### Function Prototype - -```java showLineNumbers -public void pinConversation(OnBase callBack, String conversationID, boolean isPinned) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | ----------------------------------------------- | --------- | ------------- | -| callBack | [OnBase](/callback/onBase.mdx) | Yes | Callback interface | -| conversationID | String | Yes | Conversation ID | -| isPinned | bool | Yes | Pin status | - -### Code Example - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(String data) { - - } - },conversationID,isPinned); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.pinConversation({ - conversationID: string; - isPinned: boolean; -},operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------- | -| conversationID | string | Yes | Conversation ID | -| isPinned | boolean | Yes | Pin status | - -### Return Result - -| Parameter Name | Data Type | Description | -| -------------- | ----------------------------------------------- | ------------------ | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}) - .then(({ data }) => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -``` - -ts showLineNumbers -IMSDK.asyncApi('pinConversation', operationID: string, { - conversationID: string; - isPinned: boolean; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ---------------------------------------------------------- | -| operationID | string | Yes | Operation ID, used for troubleshooting. Suggested to use current time and random number | -| conversationID | string | Yes | Conversation ID | -| isPinned | boolean | Yes | Pin status | - -### Return Result - -> Use the `openim-uniapp-polyfill` package to Promise the function. When calling, use `then` and `catch` to judge and handle success and failure callbacks. - -| Parameter Name | Data Type | Description | -| -------------- | ------------------------------------------------------ | ------------------ | -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('pinConversation', IMSDK.uuid(), { - conversationID: 'conversationID', - isPinned: true, -}) - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.pinConversation({ - conversationID: string, - isPinned: boolean, -},operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| conversationID | string | Yes | Conversation ID | -| isPinned | boolean | Yes | Whether pin | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on failed call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -OpenIMSDKRN.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}, 'operationID') - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -```C# showLineNumbers -public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned) -``` - - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ------------------------------------------------ | -------- | -------- | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) | Yes | Callback | -| conversationID | string | Yes | Conversation ID | -| isPinned | bool | Yes | Whether pin | - -### Code Example - -```C# showLineNumbers -IMSDK.((suc,errCode,errMsg)=>{ - -},conversationID,isPinned); -``` - - - - - \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationBurnDuration.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationBurnDuration.mdx deleted file mode 100644 index f78ed2948a..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversationBurnDuration.mdx +++ /dev/null @@ -1,317 +0,0 @@ ---- - -sidebar_position: 13 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# setConversationBurnDuration - -## Feature Introduction - -:::info Description - -Set the "burn after reading" duration for a single conversation. - -::: - -:::caution Note - -**Related Callback**: -[onConversationChanged](/callback/onConversationChanged.mdx) - -::: - - - - - -### Function Prototype - -```dart showLineNumbers -Future setOneConversationBurnDuration({ - required String conversationID, - int burnDuration = 30, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | --------------- | -| conversationID | String | Yes | Conversation ID | -| burnDuration | int | Yes | Duration for "burn after reading" in seconds | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | ---------------------------- | -| ~ | ~ | Successful if no exception thrown | - -### Code Example - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.setConversationBurnDuration(conversationID: conversationID); - //todo -``` - - - - - -### Function Prototype - -```swift showLineNumbers - -- (void)setConversationBurnDuration:(NSString *)conversationID - duration:(NSInteger)burnDuration - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------------------------------ | -| conversationID | NSString | Yes | Conversation ID | -| burnDuration | NSInteger | Yes | Duration for "burn after reading" in seconds | - -### Return Result - -| Name | Type | Description | -| --------- | ------------------- | ------------- | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager setConversationBurnDuration:@"" - duration:30 - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { - -}]; - -``` - - - - - -```dart showLineNumbers -public void setConversationBurnDuration(OnBase base, String conversationID, int burnDuration) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | ----------------------------------------------- | --------- | ------------------------------------ | -| base | [OnBase](/callback/onBase.mdx) | Yes | Callback interface | -| conversationID | String | Yes | Conversation ID | -| burnDuration | int | Yes | Duration for "burn after reading" in seconds | - -### Code Example - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.setConversationBurnDuration(new OnBase() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(String data) { - - } - },conversationID,burnDuration); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.setConversationBurnDuration({ - conversationID: string; - burnDuration: number; -},operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------------------------------ | -| conversationID | string | Yes | Conversation ID | -| burnDuration | number | Yes | Duration for "burn after reading" in seconds | - -### Return Result - -| Parameter Name | Data Type | Description | -| -------------- | ----------------------------------------------- | ------------------ | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); - -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); - -IMSDK.setConversationBurnDuration({ - conversationID: 'conversationID', - burnDuration: 60, -}) - .then(({ data }) => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('setConversationBurnDuration', operationID: string, { - conversationID: string; - burnDuration: number; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | --------- | --------- | ------------------------------------ | -| operationID | string | Yes | Operation ID, suggested to use current timestamp combined with a random number | -| conversationID | string | Yes | Conversation ID | -| burnDuration | number | Yes | Duration for "burn after reading" in seconds | - -### Return Result - - - -> Through the `openim-uniapp-polyfill` package, the function is promisified, so use `then` and `catch` to check and handle the success and failure callbacks respectively. - -| Parameter Name | Data Type | Description | -| -------------- | ----------------------------------------------- | ------------------ | -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('setConversationBurnDuration', IMSDK.uuid(), { - conversationID: 'conversationID', - burnDuration: 60, -}) - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.setConversationBurnDuration({ - conversationID: string, - burnDuration: number, -}, operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| conversationID | string | Yes | Conversation ID | -| burnDuration | number | Yes | Duration for "burn after reading" in seconds | -| operationID | string | Yes | Operation ID, used for problem location, keep unique, suggest using current time and random number | - -### Return Result - -| Parameter Name | Parameter Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Callback on successful call | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Callback on successful call | - -### Code Example - -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; - -OpenIMSDKRN.setConversationBurnDuration({ - conversationID: 'conversationID', - burnDuration: 60, -}, 'operationID') - .then(() => { - // Successful call - }) - .catch(({ errCode, errMsg }) => { - // Failed call - }); -``` - - - - - -```C# showLineNumbers -public static void SetConversationBurnDuration(OnSucOrError cb, string conversationID, int duration) -``` - -### Input Parameter - -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ------------------------------------------------ | -------- | -------- | -| cb | [OnSucOrError](/callback/OnSucOrError.mdx) | Yes | Callback | -| conversationID | string | Yes | Conversation ID | -| duration | int | Yes | Duration for "burn after reading" in seconds | - -### Code Example - -```C# showLineNumbers -IMSDK.SetConversationBurnDuration((suc,errCode,errMsg)=>{ - -},conversationID,duration); -``` - - - - \ No newline at end of file From 1995458911f65036dfd1863402b527c34a6564c6 Mon Sep 17 00:00:00 2001 From: Bloomingg <1293499952@qq.com> Date: Tue, 24 Sep 2024 14:42:02 +0800 Subject: [PATCH 5/8] fix: link path update --- .../api/conversation/setConversations.mdx | 261 ++--------------- docs/sdks/api/relation/updateFriends.mdx | 264 ++---------------- .../api/conversation/setConversations.mdx | 257 ++--------------- .../current/api/relation/index.mdx | 2 +- .../current/api/relation/updateFriends.mdx | 256 ++--------------- 5 files changed, 83 insertions(+), 957 deletions(-) diff --git a/docs/sdks/api/conversation/setConversations.mdx b/docs/sdks/api/conversation/setConversations.mdx index c6dead1cad..61ea613e3e 100644 --- a/docs/sdks/api/conversation/setConversations.mdx +++ b/docs/sdks/api/conversation/setConversations.mdx @@ -19,6 +19,7 @@ toc_max_heading_level: 2 **相关回调**： [onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) + ::: -### 函数原型 - -```dart showLineNumbers -Future pinConversation({ - required String conversationID, - required bool isPinned, - String? operationID, - }) -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------- | -------- | -------- | -| conversationID | String | 是 | 会话 ID | -| isPinned | bool | 是 | 是否置顶 | - -### 返回结果 - -| 名称 | 类型 | 描述 | -| ---- | ---- | -------------------- | -| ~ | ~ | 无异常抛出则操作成功 | - -### 代码示例 - -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned); - //todo -``` - - - - - -### 函数原型 - -```swift showLineNumbers - -- (void)pinConversation:(NSString *)conversationID - isPinned:(BOOL)isPinned - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------- | -------- | -------- | -| conversationID | NSString | 是 | 会话 ID | -| isPinned | BOOL | 是 | 是否置顶 | - -### 返回结果 - -| 名称 | 类型 | 描述 | -| --------- | ------------------------------------------------------ | -------- | -| onSuccess | OIMSuccessCallback | 成功返回 | -| onFailure | OIMFailureCallback | 失败返回 | - -### 代码示例 - -```swift showLineNumbers - -[OIMManager.manager pinConversation:@"" - isPinned:YES - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { +:::info 说明 -}]; +待更新 -``` +::: -### 函数原型 - -```java showLineNumbers -public void pinConversation(OnBase callBack, String conversationID, boolean isPinned) -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | ------------------------------------------------ | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 | -| conversationID | String | 是 | 会话 ID | -| isPinned | bool | 是 | 是否置顶 | - -### 代码示例 - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase() { - @Override - public void onError(int code, String error) { - - } +:::info 说明 - @Override - public void onSuccess(String data) { +待更新 - } - },conversationID,isPinned); -``` +::: -### 函数原型 - -```ts showLineNumbers -IMSDK.pinConversation({ - conversationID: string; - isPinned: boolean; -},operationID?: string): Promise -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------- | -------- | -------- | -| conversationID | string | 是 | 会话 ID | -| isPinned | boolean | 是 | 是否置顶 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - -### 代码示例 - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); +:::info 说明 -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); +待更新 -IMSDK.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}) - .then(({ data }) => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` +::: -### 函数原型 - -```ts showLineNumbers -IMSDK.asyncApi('pinConversation', operationID: string, { - conversationID: string; - isPinned: boolean; -}): Promise -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | -| conversationID | string | 是 | 会话 ID | -| isPinned | boolean | 是 | 是否置顶 | - -### 返回结果 - -> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - -### 代码示例 +:::info 说明 -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; +待更新 -IMSDK.asyncApi('pinConversation', IMSDK.uuid(), { - conversationID: 'conversationID', - isPinned: true, -}) - .then(() => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` +::: - - -### 函数原型 - -```ts showLineNumbers -OpenIMSDKRN.pinConversation({ - conversationID: string, - isPinned: boolean, -},operationID: string): Promise -``` - -### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| conversationID | string | 是 | 会话 ID | -| isPinned | boolean | 是 | 是否置顶 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | + -### 代码示例 +:::info 说明 -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +待更新 -OpenIMSDKRN.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}, 'operationID') - .then(() => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` +::: -### 函数原型 - -```C# showLineNumbers -public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned) -``` - - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | ------------------------------------------------ | -------- | -------- | -| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | 是 | 回调接口 | -| conversationID | string | 是 | 会话 ID | -| isPinned | bool | 是 | 是否置顶 | - -### 代码示例 +:::info 说明 -```C# showLineNumbers -IMSDK.((suc,errCode,errMsg)=>{ +待更新 -},conversationID,isPinned); -``` +::: diff --git a/docs/sdks/api/relation/updateFriends.mdx b/docs/sdks/api/relation/updateFriends.mdx index 9f781149c0..da386fe804 100644 --- a/docs/sdks/api/relation/updateFriends.mdx +++ b/docs/sdks/api/relation/updateFriends.mdx @@ -37,287 +37,61 @@ values={[ -### 函数原型 - -```dart showLineNumbers - Future updateFriends({ - required String userID, - required String remark, - String? operationID, - }) -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------- | -------- | ------- | -| userID | String | 是 | 用户 ID | -| remark | String | 否 | 要设置的备注，为空字符串时会取消备注 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| -------- | -------- | -------------------- | -| ~ | ~ | 无异常抛出则修改成功 | +:::info 说明 -### 代码示例 +待更新 -```dart showLineNumbers - await OpenIM.iMManager.friendshipManager.updateFriends( - userID: '1129', - remark: 'Tom', - ); - // todo -``` +::: -### 函数原型 - -```swift showLineNumbers - -- (void)updateFriends:(NSString *)userID - remark:(NSString * _Nullable)remark - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------- | -------- | ------- | -| userID | NSString | 是 | 用户 ID | -| remark | NSString | 否 | 要设置的备注，为空字符串时会取消备注 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| --------- | ------------------------------------------------------ | -------- | -| onSuccess | OIMSuccessCallback | 成功返回 | -| onFailure | OIMFailureCallback | 失败返回 | - -### 代码示例 - -```swift showLineNumbers +:::info 说明 -[OIMManager.manager updateFriends:@"" - remark:@"" - onSuccess:^(NSString * _Nullable data) { -} onFailure:^(NSInteger code, NSString * _Nullable msg) { -}]; +待更新 -``` +::: -### 函数原型 - -```java showLineNumbers - - public void updateFriends(OnBase callBack, String uid, String remark) - -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | --------------------------------------- | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 | -| uid | String | 是 | 用户 ID | -| remark | String | 是 | 备注 | - -### 返回结果 - -### 代码示例 - -```java showLineNumbers +:::info 说明 -OpenIMClient.getInstance().friendshipManager.updateFriends(new OnBase(){…},uid,remark) +待更新 -``` +::: -### 函数原型 - -```ts showLineNumbers -IMSDK.updateFriends({ - toUserID: string; - remark: string; -}, operationID?: string): Promise -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------- | -------- | ------------------------------------ | -| toUserID | string | 是 | 好友用户 ID | -| remark | string | 是 | 要设置的备注，为空字符串时会取消备注 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用成功回调 | -| Promise.catch() | Promise<[WsResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - -### 代码示例 - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); +:::info 说明 -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); +待更新 -IMSDK.updateFriends({ - toUserID: '', - remark: '', -}) - .then(() => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` +::: -### 函数原型 - -```ts showLineNumbers -IMSDK.asyncApi('updateFriends', operationID: string, { - toUserID: string; - remark: string; -}): Promise -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | -| toUserID | string | 是 | 好友用户 ID | -| remark | string | 是 | 要设置的备注，为空字符串时会取消备注 | - -### 返回结果 - -> 通过`openim-uniapp-polyfill`包将函数 Promise 化，调用时需要使用`then`和`catch`判断并处理成功和失败回调。 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - -### 代码示例 - -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; - -IMSDK.asyncApi('updateFriends', IMSDK.uuid(), { - toUserID: '', - remark: '', -}) - .then(() => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` - - - - -### 函数原型 - -```ts showLineNumbers -OpenIMSDKRN.updateFriends({ - toUserID: string; - remark: string; -}, operationID: string): Promise -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| ----------- | -------- | -------- | ------------------------------------------------------- | -| toUserID | string | 是 | 好友用户 ID | -| remark | string | 是 | 要设置的备注，为空字符串时会取消备注 | -| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 | - -### 返回结果 - -| 参数名称 | 参数类型 | 描述 | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | 调用成功回调 | -| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 | - -### 代码示例 +:::info 说明 -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +待更新 -OpenIMSDKRN.updateFriends({ - toUserID: '', - remark: '', -}, 'operationID') - .then(() => { - // 调用成功 - }) - .catch(({ errCode, errMsg }) => { - // 调用失败 - }); -``` +::: - - -### 函数原型 - -```C# showLineNumbers - -public static void UpdateFriends(OnSucOrError cb, UpdateFriendsParams userIDRemark) - -``` - -### 输入参数 - -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | --------------------------------------- | -------- | -------- | -| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | 是 | 回调接口 | -| userIDRemark |[UpdateFriendsParams](docs/sdks/class/relation/UpdateFriendsParams.mdx) | 是 | 设置参数 | - -### 返回结果 - -### 代码示例 - -```C# showLineNumbers + -IMSDK.UpdateFriends((suc,errCode,errMsg)=>{ +:::info 说明 -},new UpdateFriendsParams(){ - ToUserID = "userid", - Remark = "", -}) +待更新 -``` +::: diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx index c4c038d0e4..6287d24204 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversations.mdx @@ -17,7 +17,7 @@ Set session information. :::caution Note **Related Callback**: -[onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) +[onConversationChanged](callback/onConversationChanged.mdx) ::: @@ -36,283 +36,70 @@ values={[ -### Function Prototype - -```dart showLineNumbers -Future pinConversation({ - required String conversationID, - required bool isPinned, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | -------- | -------- | -------- | -| conversationID | String | Yes | conversation id | -| isPinned | bool | Yes | is it pinned | - -### Return Result - -| Name | Type | Description | -| ---- | ---- | -------------------- | -| ~ | ~ | Successful if no exception thrown | +:::info Description -### Code Example +To be updated. -```dart showLineNumbers - await OpenIM.iMManager.conversationManager.pinConversation(conversationID: conversationID, isPinned: isPinned); - //todo -``` +::: -### Function Prototype - -```swift showLineNumbers - -- (void)pinConversation:(NSString *)conversationID - isPinned:(BOOL)isPinned - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | -------- | -------- | -------- | -| conversationID | NSString | Yes | conversation id | -| isPinned | BOOL | Yes | is it pinned | - -### Return Result - -| 名称 | 类型 | Description | -| --------- | ------------------------------------------------------ | -------- | -| onSuccess | OIMSuccessCallback | Successful return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers - -[OIMManager.manager pinConversation:@"" - isPinned:YES - onSuccess:^(NSString * _Nullable data) { - -} onFailure:^(NSInteger code, NSString * _Nullable msg) { +:::info Description -}]; +To be updated. -``` +::: -### Function Prototype - -```java showLineNumbers -public void pinConversation(OnBase callBack, String conversationID, boolean isPinned) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | ------------------------------------------------ | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | Yes | Callback interface | -| conversationID | String | Yes | conversation id | -| isPinned | bool | Yes | is it pinned | - -### Code Example - -```java showLineNumbers - OpenIMClient.getInstance().conversationManager.pinConversation(new OnBase() { - @Override - public void onError(int code, String error) { - - } +:::info Description - @Override - public void onSuccess(String data) { +To be updated. - } - },conversationID,isPinned); -``` +::: -### Function Prototype - -```ts showLineNumbers -IMSDK.pinConversation({ - conversationID: string; - isPinned: boolean; -},operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | -------- | -------- | -------- | -| conversationID | string | Yes | conversation id | -| isPinned | boolean | Yes | is it pinned | - -### Return Result - -| Parameter Name | Data Type | Description | -| --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Success callback | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Failure callback | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); - -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); +:::info Description -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); +To be updated. -IMSDK.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}) - .then(({ data }) => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` +::: -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('pinConversation', operationID: string, { - conversationID: string; - isPinned: boolean; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | -| conversationID | string | Yes | conversation id | -| isPinned | boolean | Yes | is it pinned | - -### Return Result - -> Use the `openim-uniapp-polyfill` package to convert the function into a Promise. When calling, you need to use `then` and `catch` to judge and handle the success and failure callbacks. - -| Parameter Name | Data Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example +:::info Description -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; +To be updated. -IMSDK.asyncApi('pinConversation', IMSDK.uuid(), { - conversationID: 'conversationID', - isPinned: true, -}) - .then(() => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` +::: -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.pinConversation({ - conversationID: string, - isPinned: boolean, -},operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | -------- | -------- | ------------------------------------------------------- | -| conversationID | string | Yes | conversation id | -| isPinned | boolean | Yes | is it pinned | -| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | - -### Return Result - -| Parameter Name | Data Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Success callback | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Failure callback | - -### Code Example +:::info Description -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +To be updated. -OpenIMSDKRN.pinConversation({ - conversationID: 'conversationID', - isPinned: true, -}, 'operationID') - .then(() => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` +::: -### Function Prototype - -```C# showLineNumbers -public static void PinConversation(OnSucOrError cb, string conversationID, bool isPinned) -``` - - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------------- | ------------------------------------------------ | -------- | -------- | -| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | Yes | Callback interface | -| conversationID | string | Yes | conversation id | -| isPinned | bool | Yes | is it pinned | - -### Code Example +:::info Description -```C# showLineNumbers -IMSDK.((suc,errCode,errMsg)=>{ +To be updated. -},conversationID,isPinned); -``` +::: diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx index 81be944778..c1bf9c9b60 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/index.mdx @@ -30,4 +30,4 @@ SDK related to friends and blacklist. | [addBlack](/api/relation/addBlack.mdx) | Add to blacklist | | [getBlackList](/api/relation/getBlackList.mdx) | Retrieve blacklist | | [removeBlack](/api/relation/removeBlack.mdx) | Remove from blacklist | -| [updateFriends](/api/relation/updateFriends) | Modify friend information | \ No newline at end of file +| [updateFriends](/api/relation/updateFriends.mdx) | Modify friend information | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx index 27aa08c58e..857ebf144b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx @@ -37,287 +37,73 @@ values={[ -### Function Prototype - -```dart showLineNumbers - Future updateFriends({ - required String userID, - required String remark, - String? operationID, - }) -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------- | -------- | -------- | ------- | -| userID | String | Yes | user id | -| remark | String | No | set remark | - -### Return Result - -| Parameter Name | Data Type | Description | -| -------- | -------- | -------------------- | -| ~ | ~ | If no exception is thrown, the modification is successful | +:::info Description -### Code Example +To be updated. -```dart showLineNumbers - await OpenIM.iMManager.friendshipManager.updateFriends( - userID: '1129', - remark: 'Tom', - ); - // todo -``` +::: -### Function Prototype - -```swift showLineNumbers - -- (void)updateFriends:(NSString *)userID - remark:(NSString * _Nullable)remark - onSuccess:(nullable OIMSuccessCallback)onSuccess - onFailure:(nullable OIMFailureCallback)onFailure; - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------- | -------- | -------- | ------- | -| userID | NSString | Yes | user id | -| remark | NSString | No | set remark | - -### Return Result - -| Parameter Name | Data Type | Description | -| --------- | ------------------------------------------------------ | -------- | -| onSuccess | OIMSuccessCallback | Successful return | -| onFailure | OIMFailureCallback | Failure return | - -### Code Example - -```swift showLineNumbers +:::info Description -[OIMManager.manager updateFriends:@"" - remark:@"" - onSuccess:^(NSString * _Nullable data) { -} onFailure:^(NSInteger code, NSString * _Nullable msg) { -}]; +To be updated. -``` +::: -### Function Prototype - -```java showLineNumbers - - public void updateFriends(OnBase callBack, String uid, String remark) - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------- | --------------------------------------- | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | Yes | Callback interface | -| uid | String | Yes | user id | -| remark | String | Yes | remark | - -### Return Result - -### Code Example +:::info Description -```java showLineNumbers +To be updated. -OpenIMClient.getInstance().friendshipManager.updateFriends(new OnBase(){…},uid,remark) +::: -``` -### Function Prototype - -```ts showLineNumbers -IMSDK.updateFriends({ - toUserID: string; - remark: string; -}, operationID?: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------- | -------- | -------- | ------------------------------------ | -| toUserID | string | Yes | friend user id | -| remark | string | Yes | set remark | - -### Return Result - -| Parameter Name | Data Type | Description | -| --------------- | ---------------------------------------------------- | ------------ | -| Promise.then() | Promise<[WsResponse](/class/response.mdx)\> | Call success | -| Promise.catch() | Promise<[WsResponse](/class/response.mdx)\> | Call failed | - -### Code Example - -```js showLineNumbers -import { getSDK } from 'open-im-sdk-wasm'; -const IMSDK = getSDK(); +:::info Description -// use in electron with ffi -// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render'; -// const { instance: IMSDK } = getWithRenderProcess(); +To be updated. -// use in mini program -// import { OpenIMSDK } from 'open-im-sdk'; -// const IMSDK = new OpenIMSDK(); +::: -IMSDK.updateFriends({ - toUserID: '', - remark: '', -}) - .then(() => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` -### Function Prototype - -```ts showLineNumbers -IMSDK.asyncApi('updateFriends', operationID: string, { - toUserID: string; - remark: string; -}): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| ----------- | -------- | -------- | ------------------------------------------------------- | -| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | -| toUserID | string | Yes | friend user id | -| remark | string | Yes | set remark | - -### Return Result - -> Use the `openim-uniapp-polyfill` package to convert the function into a Promise. When calling, you need to use `then` and `catch` to judge and handle the success and failure callbacks. - -| Parameter Name | Data Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Call success | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Call failed | - -### Code Example +:::info Description -```js showLineNumbers -import IMSDK from 'openim-uniapp-polyfill'; +To be updated. -IMSDK.asyncApi('updateFriends', IMSDK.uuid(), { - toUserID: '', - remark: '', -}) - .then(() => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` +::: -### Function Prototype - -```ts showLineNumbers -OpenIMSDKRN.updateFriends({ - toUserID: string; - remark: string; -}, operationID: string): Promise -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| ----------- | -------- | -------- | ------------------------------------------------------- | -| toUserID | string | Yes | friend user id | -| remark | string | Yes | set remark | -| operationID | string | Yes | Operation ID, for troubleshooting. Recommended to use current time combined with random number | - -### Return Result - -| Parameter Name | Data Type | Description | -| --------------- | ------------------------------------------------------- | ------------ | -| Promise.then() | Promise | Call success | -| Promise.catch() | Promise<[CatchResponse](/class/response.mdx)\> | Call failed | +:::info Description -### Code Example +To be updated. -```js showLineNumbers -import OpenIMSDKRN from "open-im-sdk-rn"; +::: -OpenIMSDKRN.updateFriends({ - toUserID: '', - remark: '', -}, 'operationID') - .then(() => { - // Call success - }) - .catch(({ errCode, errMsg }) => { - // Call failed - }); -``` -### Function Prototype - -```C# showLineNumbers - -public static void UpdateFriends(OnSucOrError cb, UpdateFriendsParams userIDRemark) - -``` - -### Input Parameters - -| Parameter Name | Data Type | Mandatory | Description | -| -------- | --------------------------------------- | -------- | -------- | -| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) | Yes | Callback interface | -| userIDRemark |[UpdateFriendsParams](docs/sdks/class/relation/UpdateFriendsParams.mdx) | Yes | Setting parameters | - -### Return Result - -### Code Example - -```C# showLineNumbers - -IMSDK.UpdateFriends((suc,errCode,errMsg)=>{ +:::info Description -},new UpdateFriendsParams(){ - ToUserID = "userid", - Remark = "", -}) +To be updated. -``` +::: From 05878c44171ed9e521fdb26c9914f0c4c8583024 Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Thu, 26 Dec 2024 10:05:47 +0800 Subject: [PATCH 6/8] feat: s3 doc --- docs/guides/solution/s3.mdx | 119 ++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 docs/guides/solution/s3.mdx diff --git a/docs/guides/solution/s3.mdx b/docs/guides/solution/s3.mdx new file mode 100644 index 0000000000..f76091d0b2 --- /dev/null +++ b/docs/guides/solution/s3.mdx @@ -0,0 +1,119 @@ +--- +title: '如何接入S3存储' +sidebar_position: 8 + +--- + +# S3存储接入 + +- OpenIM支持接入多种S3存储服务，包括：MINIO、阿里云OSS、腾讯云COS、七牛云KODO以及AWS，为开发者提供了广泛的选择。 +- 文件通过SDK直接上传至S3存储，避免经过API服务器，从而显著提升服务端性能。 +- 如果需要接入其他S3存储类型，也完全支持扩展。只需在服务端实现对应接口，无需对SDK进行任何修改。[接口地址](https://github.com/openimsdk/tools/blob/main/s3/s3.go) +- 访问时调用的API地址仅用于将请求重定向至真实的S3存储地址，同时可在此阶段加入与业务相关的权限校验，确保数据安全性和业务灵活性。 + +- 将 `config/openim-rpc-third.yml` 文件中的 `object.enable: ` 修改为 `minio`、`oss`、`cos`、`kodo` 或 `aws` +```yaml +object: + enable: minio +``` + +# MINIO + +1. 修改 config/minio.yml 文件中的 externalAddress 为你的应用访问地址，服务器无需能访问此地址。 +```yaml +# 中的存储桶名称 +bucket: openim +# 身份验证的访问密钥ID +accessKeyID: root +# 身份验证的访问密钥 +secretAccessKey: openIM123 +# 身份验证的会话令牌（可选） +sessionToken: +# 服务器的内部地址 +internalAddress: localhost:10005 +# 服务器的外部地址，可从外部访问，支持使用域名的HTTP和HTTPS +externalAddress: http://external_ip:10005 +# 是否启用存储桶的公共读权限 +publicRead: false +``` + + +# 阿里云OSS +1. OSS创建存储桶地址: https://oss.console.aliyun.com/bucket +2. AccessKey生成地址: https://ram.console.aliyun.com/profile/access-keys +3. 官方文档: https://help.aliyun.com/zh/oss/developer-reference/overview-25/?spm=a2c4g.11186623.0.i3 +4. 修改`config/openim-rpc-third.yml`文件`object.oss`。 +```yaml +# OSS数据中心端点，例如 http://oss-cn-hangzhou.aliyuncs.com . +endpoint: +# 存储桶名称 +bucket: +# 存储桶URL +bucketURL: +# 访问密钥ID +accessKeyID: +# 访问密钥Secret +accessKeySecret: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +publicRead: false +``` + +# 腾讯云COS +1. COS创建存储桶地址: https://console.cloud.tencent.com/cos5/bucket +2. AccessKey生成地址: https://console.cloud.tencent.com/cam/capi +3. 官方文档: https://cloud.tencent.com/document/product/436/7751 +4. 修改`config/openim-rpc-third.yml`文件`object.cos` +```yaml +# 存储桶URL +bucketURL: +# 访问密钥ID +secretID: +# 访问密钥Secret +secretKey: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +publicRead: false +``` + +# 七牛云KODO +1. KODO创建存储桶地址: https://portal.qiniu.com/kodo/bucket +2. AccessKey生成地址: https://portal.qiniu.com/developer/user/key +3. 官方文档: https://developer.qiniu.com/kodo/1644/security +4. 修改`config/openim-rpc-third.yml`文件`object.kodo` +```yaml +# 七牛云KODO的Endpoint地址，例如：http://s3.cn-south-1.qiniucs.com +endpoint: +# 存储桶名称 +bucket: kodo-bucket-test +# 存储桶URL +bucketURL: http://kodo-bucket-test-oetobfb.qiniudns.com +# 访问密钥ID +accessKeyID: +# 访问密钥Secret +accessKeySecret: +# 会话令牌（可选） +sessionToken: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +publicRead: false +``` + + +# AWS +1. 区域文档: http://docs.aws.amazon.com/general/latest/gr/rande.html +2. AWS创建存储桶地址: https://s3.console.aws.amazon.com/s3/home +3. AccessKey生成地址: https://console.aws.amazon.com/iam/home?#/security_credentials +4. 官方文档: https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/userguide/Welcome.html +修改`config/openim-rpc-third.yml`文件`object.aws` +```yaml +# 发送请求的区域，参考：http://docs.aws.amazon.com/general/latest/gr/rande.html +region: +# 存储桶名称 +bucket: +# AWS访问密钥ID +accessKeyID: +# AWS访问密钥Secret +secretAccessKey: +# AWS会话令牌 +sessionToken: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +publicRead: false +``` \ No newline at end of file From 0a7d2d97a7f9ab6fb4237a48ced7eac08a8b7c89 Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Thu, 26 Dec 2024 11:28:15 +0800 Subject: [PATCH 7/8] feat: s3 doc --- docs/guides/solution/s3.mdx | 71 ++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 33 deletions(-) diff --git a/docs/guides/solution/s3.mdx b/docs/guides/solution/s3.mdx index f76091d0b2..c9560afd67 100644 --- a/docs/guides/solution/s3.mdx +++ b/docs/guides/solution/s3.mdx @@ -8,10 +8,11 @@ sidebar_position: 8 - OpenIM支持接入多种S3存储服务，包括：MINIO、阿里云OSS、腾讯云COS、七牛云KODO以及AWS，为开发者提供了广泛的选择。 - 文件通过SDK直接上传至S3存储，避免经过API服务器，从而显著提升服务端性能。 -- 如果需要接入其他S3存储类型，也完全支持扩展。只需在服务端实现对应接口，无需对SDK进行任何修改。[接口地址](https://github.com/openimsdk/tools/blob/main/s3/s3.go) - 访问时调用的API地址仅用于将请求重定向至真实的S3存储地址，同时可在此阶段加入与业务相关的权限校验，确保数据安全性和业务灵活性。 +- API使用nginx代理，需要添加`proxy_set_header X-Request-Api $scheme://$host/api;`，参考文档：[Nginx配置](https://docs.openim.io/zh-Hans/guides/gettingStarted/nginxDomainConfig) +- 如需要接入其他S3存储类型，也完全支持扩展。只需在服务端实现对应接口，无需对SDK进行任何修改。[接口地址](https://github.com/openimsdk/tools/blob/main/s3/s3.go) -- 将 `config/openim-rpc-third.yml` 文件中的 `object.enable: ` 修改为 `minio`、`oss`、`cos`、`kodo` 或 `aws` +- 将 `config/openim-rpc-third.yml` 文件中的 `object.enable: ` 修改为 `minio`、`oss`、`cos`、`kodo` 或 `aws`, 默认为 `minio`。 ```yaml object: enable: minio @@ -20,41 +21,43 @@ object: # MINIO 1. 修改 config/minio.yml 文件中的 externalAddress 为你的应用访问地址，服务器无需能访问此地址。 +2. 使用minio nginx参考文档: https://docs.openim.io/zh-Hans/guides/gettingStarted/nginxDomainConfig ```yaml -# 中的存储桶名称 +# 存储桶名称，用于存储和管理文件。 bucket: openim -# 身份验证的访问密钥ID +# 用于身份验证的访问密钥ID。 accessKeyID: root -# 身份验证的访问密钥 +# 用于身份验证的访问密钥Secret。 secretAccessKey: openIM123 -# 身份验证的会话令牌（可选） +# 会话令牌，若使用临时凭证则需要填写此项。 sessionToken: -# 服务器的内部地址 +# 服务器的内部地址。 internalAddress: localhost:10005 -# 服务器的外部地址，可从外部访问，支持使用域名的HTTP和HTTPS +# 服务器的外部地址，可从外部访问，支持使用域名的HTTP和HTTPS，确保该地址客户端可访问。服务器无需能访问此地址，只用作签名使用。 externalAddress: http://external_ip:10005 -# 是否启用存储桶的公共读权限 +# 是否启用存储桶的公共读权限，当设置为true，会自动将桶改为公共读权限，后续改为false不会将权限设置为私有。 publicRead: false ``` - # 阿里云OSS 1. OSS创建存储桶地址: https://oss.console.aliyun.com/bucket 2. AccessKey生成地址: https://ram.console.aliyun.com/profile/access-keys 3. 官方文档: https://help.aliyun.com/zh/oss/developer-reference/overview-25/?spm=a2c4g.11186623.0.i3 4. 修改`config/openim-rpc-third.yml`文件`object.oss`。 ```yaml -# OSS数据中心端点，例如 http://oss-cn-hangzhou.aliyuncs.com . +# OSS数据中心端点，例如：http://oss-cn-hangzhou.aliyuncs.com endpoint: -# 存储桶名称 +# 存储桶名称，用于存储和管理文件。 bucket: -# 存储桶URL +# 存储桶的外部访问 URL，通常是加速后的访问地址。 bucketURL: -# 访问密钥ID +# 用于身份验证的访问密钥ID。 accessKeyID: -# 访问密钥Secret +# 用于身份验证的访问密钥Secret。 accessKeySecret: -# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +# 会话令牌，若使用临时凭证则需要填写此项。 +sessionToken: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名，设置为true时，需要自行在oss管理后台设置。 publicRead: false ``` @@ -64,13 +67,15 @@ publicRead: false 3. 官方文档: https://cloud.tencent.com/document/product/436/7751 4. 修改`config/openim-rpc-third.yml`文件`object.cos` ```yaml -# 存储桶URL +# 存储桶URL Endpoint地址，例如：https://temp-1252357374.cos.ap-chengdu.myqcloud.com bucketURL: -# 访问密钥ID +# 用于身份验证的访问密钥ID。 secretID: -# 访问密钥Secret +# 用于身份验证的访问密钥Secret。 secretKey: -# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +# 会话令牌，若使用临时凭证则需要填写此项。 +sessionToken: +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名，设置为true时，需要自行在cos管理后台设置。 publicRead: false ``` @@ -82,38 +87,38 @@ publicRead: false ```yaml # 七牛云KODO的Endpoint地址，例如：http://s3.cn-south-1.qiniucs.com endpoint: -# 存储桶名称 +# 存储桶名称，用于存储和管理文件。 bucket: kodo-bucket-test -# 存储桶URL -bucketURL: http://kodo-bucket-test-oetobfb.qiniudns.com -# 访问密钥ID +# 存储桶URL Endpoint地址，例如：http://kodo-bucket-test-oetobfb.qiniudns.com +bucketURL: +# 用于身份验证的访问密钥ID。 accessKeyID: -# 访问密钥Secret +# 用于身份验证的访问密钥Secret。 accessKeySecret: -# 会话令牌（可选） +# 会话令牌，若使用临时凭证则需要填写此项。 sessionToken: -# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名，需要自行在kodo管理后台设置。 publicRead: false ``` - # AWS 1. 区域文档: http://docs.aws.amazon.com/general/latest/gr/rande.html 2. AWS创建存储桶地址: https://s3.console.aws.amazon.com/s3/home 3. AccessKey生成地址: https://console.aws.amazon.com/iam/home?#/security_credentials 4. 官方文档: https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/userguide/Welcome.html +5. AWS暂时不支持通过URL参数生成缩略图。 修改`config/openim-rpc-third.yml`文件`object.aws` ```yaml # 发送请求的区域，参考：http://docs.aws.amazon.com/general/latest/gr/rande.html region: -# 存储桶名称 +# 存储桶名称，用于存储和管理文件。 bucket: -# AWS访问密钥ID +# 用于身份验证的访问密钥ID。 accessKeyID: -# AWS访问密钥Secret +# 用于身份验证的访问密钥Secret。 secretAccessKey: -# AWS会话令牌 +# 会话令牌，若使用临时凭证则需要填写此项。 sessionToken: -# 公共读取模式，建议设置为false，否则无法设置下载的Content-Type和文件名 +# 公共读取模式。暂时不支持设置为true publicRead: false ``` \ No newline at end of file From efe0a2644c91c6598188028ebe1613f3a5678a55 Mon Sep 17 00:00:00 2001 From: withchao <993506633@qq.com> Date: Thu, 26 Dec 2024 11:36:57 +0800 Subject: [PATCH 8/8] feat: s3 doc --- docs/guides/solution/s3.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/solution/s3.mdx b/docs/guides/solution/s3.mdx index c9560afd67..45117e5834 100644 --- a/docs/guides/solution/s3.mdx +++ b/docs/guides/solution/s3.mdx @@ -31,7 +31,7 @@ accessKeyID: root secretAccessKey: openIM123 # 会话令牌，若使用临时凭证则需要填写此项。 sessionToken: -# 服务器的内部地址。 +# 服务器的内部地址，只用于服务器内部调用，一般是内网地址。 internalAddress: localhost:10005 # 服务器的外部地址，可从外部访问，支持使用域名的HTTP和HTTPS，确保该地址客户端可访问。服务器无需能访问此地址，只用作签名使用。 externalAddress: http://external_ip:10005