From de7c526ed292794abc88d98e8f786165c51c7aff Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 29 Sep 2024 14:32:05 +0800 Subject: [PATCH 01/10] docs: update docs about android --- .../sdks/api/conversation/setConversation.mdx | 30 +++++++++++++++-- docs/sdks/api/group/setGroupInfo.mdx | 26 +++++++-------- docs/sdks/api/relation/getFriendList.mdx | 21 +++++------- docs/sdks/api/relation/getFriendListPage.mdx | 24 +++++++------- .../api/relation/getSpecifiedFriendsInfo.mdx | 31 +++++++++--------- docs/sdks/api/relation/updateFriends.mdx | 27 ++++++++++++++-- docs/sdks/api/user/getUsersInfo.mdx | 28 +++++++--------- docs/sdks/api/user/setSelfInfo.mdx | 32 ++++++++++++------- .../class/conversation/conversationReq.mdx | 9 ++++++ docs/sdks/class/relation/updateFriendsReq.mdx | 10 +++++- 10 files changed, 147 insertions(+), 91 deletions(-) diff --git a/docs/sdks/api/conversation/setConversation.mdx b/docs/sdks/api/conversation/setConversation.mdx index 97c8e31662..cfe080e44a 100644 --- a/docs/sdks/api/conversation/setConversation.mdx +++ b/docs/sdks/api/conversation/setConversation.mdx @@ -114,11 +114,35 @@ Future setConversation( -:::info 说明 +### 函数原型 -待更新 +```java showLineNumbers +public void setConversation(OnBase base, String conversationID, ConversationReq conversationReq) +``` -::: +### 输入参数 + +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------------- | -------- | -------- | ------- | +| conversationID | String | 是 | 会话 ID | +| conversationReq | [ConversationReq](docs/sdks/class/conversation/conversationReq.mdx) | 是 | 变更的结构体 | + +### 返回结果 + +### 代码示例 + +```java showLineNumbers +OpenIMClient.getInstance().conversationManager.setConversation(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(String data) { + // todo: 请求成功 + } +}, conversationID , conversationReq); +``` diff --git a/docs/sdks/api/group/setGroupInfo.mdx b/docs/sdks/api/group/setGroupInfo.mdx index 91a78df627..7c9e74100f 100644 --- a/docs/sdks/api/group/setGroupInfo.mdx +++ b/docs/sdks/api/group/setGroupInfo.mdx @@ -115,32 +115,30 @@ param.introduction = @""; ### 函数原型 ```java showLineNumbers - public void setGroupInfo(GroupInfo groupInfo, OnBase callBack) + public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase callBack) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| ------------ | --------------------------------------- | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 | -| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 是 | 群 信息 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| ---------------- | --------------------------------------------------------------- | -------- | -------- | +| groupMembersInfo | [SetGroupMemberInfo](docs/sdks/class/group/SetGroupMemberInfo.mdx) | 是 | 成员信息 | ### 返回结果 ### 代码示例 ```java showLineNumbers - OpenIMClient.getInstance().groupManager.setGroupInfo(groupInfo,new OnBase() { - @Override - public void onError(int code, String error) { +OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo,new OnBase() { + @Override + public void onError(int code, String error) { - } + } + @Override + public void onSuccess(String data) { - @Override - public void onSuccess(String data) { - - } - }); + } +}); ``` diff --git a/docs/sdks/api/relation/getFriendList.mdx b/docs/sdks/api/relation/getFriendList.mdx index 6887c3a576..007e9357df 100644 --- a/docs/sdks/api/relation/getFriendList.mdx +++ b/docs/sdks/api/relation/getFriendList.mdx @@ -99,16 +99,14 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 函数原型 ```java showLineNumbers - - public void getFriendList(OnBase> callBack) - + public void getFriendListByFilterBlack(OnBase> base, Boolean filterBlack) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------------------------------------------------------------------------------------------- | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx)\> | 是 | 回调接口 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------- | -------- | -------- | ------- | +| filterBlack | Boolean | 否 | 是否过滤掉黑名单 | ### 返回结果 @@ -119,19 +117,16 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 代码示例 ```java showLineNumbers - -OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>(){ +OpenIMClient.getInstance().friendshipManager.getFriendListByFilterBlack(new OnBase>() { @Override public void onError(int code, String error) { - + // todo: 处理错误信息 } - @Override public void onSuccess(List data) { - + // todo: 请求成功，返回List } -}) - +}, filterBlack); ``` diff --git a/docs/sdks/api/relation/getFriendListPage.mdx b/docs/sdks/api/relation/getFriendListPage.mdx index 671ee7ef4c..e08cbf85ce 100644 --- a/docs/sdks/api/relation/getFriendListPage.mdx +++ b/docs/sdks/api/relation/getFriendListPage.mdx @@ -115,16 +115,16 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 函数原型 ```java showLineNumbers - - public void getFriendList(OnBase> callBack) - +public void getFriendListPageByFilterBlack(OnBase> base, int offset, int count, Boolean filterBlack) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------------------------------------------------------------------------------------------- | -------- | -------- | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx)> | 是 | 回调接口 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------- | -------- | -------- | ------- | +| offset | int | 是 | 分页拉取起始下标 | +| count | int | 是 | 一页拉取的数量 | +| filterBlack | Boolean | 否 | 是否过滤掉黑名单 | ### 返回结果 @@ -134,20 +134,18 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 代码示例 -```java showLineNumbers -OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>(){ +```java showLineNumbers +OpenIMClient.getInstance().friendshipManager.getFriendListPageByFilterBlack(new OnBase>() { @Override public void onError(int code, String error) { - + // todo: 处理错误信息 } - @Override public void onSuccess(List data) { - + // todo: 请求成功，返回List } -}) - +}, filterBlack); ``` diff --git a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx index b9eb743de5..cb9546425f 100644 --- a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx +++ b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx @@ -107,31 +107,30 @@ values={[ ### 函数原型 ```java showLineNumbers - public void getFriendsInfo(OnBase> base, List uidList) +public void getFriendsInfoByFilterBlack(OnBase> base, List uidList, Boolean filterBlack) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx)> | 是 | 回调接口 | -| uidList | List | 是 | 用户 ID 集合 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| ---------- | ------------- | -------- | ------------ | +| userIDList | List\ | 是 | 用户 ID 列表 | +| filterBlack | Boolean | 否 | 是否过滤掉黑名单 | ### 代码示例 ```java showLineNumbers - OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase>() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(List data) { - - } - },uidList); +OpenIMClient.getInstance().friendshipManager.getFriendsInfoByFilterBlack(new OnBase>() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(List data) { + // todo: 请求成功，返回List + } +}, uidList, filterBlack); ``` diff --git a/docs/sdks/api/relation/updateFriends.mdx b/docs/sdks/api/relation/updateFriends.mdx index ce36660087..d1d1484660 100644 --- a/docs/sdks/api/relation/updateFriends.mdx +++ b/docs/sdks/api/relation/updateFriends.mdx @@ -109,11 +109,32 @@ Future updateFriends( -:::info 说明 +```java showLineNumbers +public void updateFriendsReq(OnBase base, UpdateFriendsReq updateFriendsReq) +``` -待更新 +### 输入参数 -::: +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------------- | -------- | -------- | ------- | +| updateFriendsReq | [UpdateFriendsReq](docs/sdks/class/relation/updateFriendsReq.mdx) | 是 | 变更的结构体 | + +### 返回结果 + +### 代码示例 + +```java showLineNumbers +OpenIMClient.getInstance().friendshipManager.updateFriendsReq(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(String data) { + // todo: 请求成功 + } +}, updateFriendsReq); +``` diff --git a/docs/sdks/api/user/getUsersInfo.mdx b/docs/sdks/api/user/getUsersInfo.mdx index 7a4d661889..80b29e980f 100644 --- a/docs/sdks/api/user/getUsersInfo.mdx +++ b/docs/sdks/api/user/getUsersInfo.mdx @@ -112,16 +112,14 @@ await OpenIM.iMManager.userManager.getUsersInfoWithCache([], ''); ### 函数原型 ```java showLineNumbers - -public void getUsersInfoWithCache(OnBase> callBack, List uidList,String groupID) - +public void getUsersInfo(OnBase> callBack, List uidList) ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx)> | 是 | 回调接口 | +| callBack | [OnBase](docs/sdks/callback/onBase.mdx)> | 是 | 回调接口 | | uidList | List | 是 | 用户 ID 集合 | | groupID | String | false | 群ID | ### 返回结果 @@ -129,18 +127,16 @@ public void getUsersInfoWithCache(OnBase> callBack, List ### 代码示例 ```java showLineNumbers - OpenIMClient.getInstance().userInfoManager.getUsersInfoWithCache(new OnBase>() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(List data) { - - } - },uidList,groupId); - +OpenIMClient.getInstance().userInfoManager.getUsersInfo(new OnBase>() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(List data) { + // todo: 请求成功，返回PublicUser + } +},uidList); ``` diff --git a/docs/sdks/api/user/setSelfInfo.mdx b/docs/sdks/api/user/setSelfInfo.mdx index dc304fa03d..23ce5abf17 100644 --- a/docs/sdks/api/user/setSelfInfo.mdx +++ b/docs/sdks/api/user/setSelfInfo.mdx @@ -125,21 +125,20 @@ info.faceURL = @""; ### 函数原型 ```java showLineNumbers - - public void setSelfInfo(OnBase callBack, String nickname, String faceURL, int appMangerLevel, String ex) - + public void setSelfInfo(OnBase base, UserInfoReq userInfoReq) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | --------------------------------------- | -------- | ------------------------------ | -| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 | -| nickname | String | 是 | 名字 | -| faceURL | String | 是 | 用户头像URL | -| gender | int | 是 | 性别 1：男 2：女 | -| appMangerLevel | int | 是 | 内部字段，可忽略 | -| ex | String | 否 | 扩展字段 | +请求结构体UserInfoReq属性如下所示： + +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------------- | -------- | -------- | -------------- | +| userID | String | 是 | 用户id | +| nickname | String | 否 | 用户昵称 | +| faceURL | String | 否 | 用户头像 | +| ex | String | 否 | 扩展参数 | +| globalRecvMsgOpt | Integer | 否 | 全局免打扰，1:屏蔽消息; 2:接收消息但不提示; 0:正常 | ### 返回结果 @@ -147,7 +146,16 @@ info.faceURL = @""; ```java showLineNumbers -OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase(){…},...); +OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase(){ + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(String data) { + // todo: 请求成功 + } +},userInfoReq); ``` diff --git a/docs/sdks/class/conversation/conversationReq.mdx b/docs/sdks/class/conversation/conversationReq.mdx index ca5c1c41c9..80ffb5282c 100644 --- a/docs/sdks/class/conversation/conversationReq.mdx +++ b/docs/sdks/class/conversation/conversationReq.mdx @@ -61,6 +61,15 @@ values={[ ### ConversationReq +| 字段名称 | 字段类型 | 描述 | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 | +| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @类型 | +| isPinned | boolean | 是否置顶 | +| isPrivateChat | boolean | 是否开启了阅后即焚 | +| burnDuration | int | 阅后即焚时间（秒） | +| ex | String | 扩展字段 | + diff --git a/docs/sdks/class/relation/updateFriendsReq.mdx b/docs/sdks/class/relation/updateFriendsReq.mdx index 0ef345ac93..51b4bad285 100644 --- a/docs/sdks/class/relation/updateFriendsReq.mdx +++ b/docs/sdks/class/relation/updateFriendsReq.mdx @@ -55,7 +55,15 @@ values={[ -### ConversationReq +### UpdateFriendsReq + +| 字段名称 | 字段类型 | 描述 | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| remark | String | 备注 | +| isPinned | Boolean | 是否置顶 | +| friendUserIDs | String[] | 好友的User ID列表 | +| ex | String | 扩展字段 | + From f7b7f01a63429b447a607e97f14a8629136c71cc Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 29 Sep 2024 15:26:00 +0800 Subject: [PATCH 02/10] fix: some problems --- docs/sdks/api/group/setGroupInfo.mdx | 10 +++++----- docs/sdks/api/group/setGroupMemberInfo.mdx | 17 +++++++---------- docs/sdks/api/relation/getFriendList.mdx | 4 ++-- docs/sdks/api/relation/getFriendListPage.mdx | 4 ++-- .../api/relation/getSpecifiedFriendsInfo.mdx | 4 ++-- 5 files changed, 18 insertions(+), 21 deletions(-) diff --git a/docs/sdks/api/group/setGroupInfo.mdx b/docs/sdks/api/group/setGroupInfo.mdx index 7c9e74100f..0def1c88ef 100644 --- a/docs/sdks/api/group/setGroupInfo.mdx +++ b/docs/sdks/api/group/setGroupInfo.mdx @@ -115,28 +115,28 @@ param.introduction = @""; ### 函数原型 ```java showLineNumbers - public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase callBack) +public void setGroupInfo(GroupInfo groupInfo, OnBase callBack) ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | | ---------------- | --------------------------------------------------------------- | -------- | -------- | -| groupMembersInfo | [SetGroupMemberInfo](docs/sdks/class/group/SetGroupMemberInfo.mdx) | 是 | 成员信息 | +| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 是 | 成员信息 | ### 返回结果 ### 代码示例 ```java showLineNumbers -OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo,new OnBase() { +OpenIMClient.getInstance().groupManager.setGroupInfo(groupInfo, new OnBase() { @Override public void onError(int code, String error) { - + // todo: 处理错误信息 } @Override public void onSuccess(String data) { - + // todo: 请求成功 } }); ``` diff --git a/docs/sdks/api/group/setGroupMemberInfo.mdx b/docs/sdks/api/group/setGroupMemberInfo.mdx index ba226875bc..91d3f36955 100644 --- a/docs/sdks/api/group/setGroupMemberInfo.mdx +++ b/docs/sdks/api/group/setGroupMemberInfo.mdx @@ -110,31 +110,28 @@ values={[ ### 函数原型 ```java showLineNumbers - public void setGroupMemberInfo(String groupID,String userID,String ex,OnBase callBack)) + public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase callBack) ``` ### 输入参数 -| 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------- | -------- | -------- | ------------ | -| groupID | String | 是 | 群ID | -| userID | String | 是 | 用户 ID | -| ex | String | 是 | 成员扩展信息 | +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| ---------------- | --------------------------------------------------------------- | -------- | -------- | +| groupMembersInfo | [SetGroupMemberInfo](docs/sdks/class/group/SetGroupMemberInfo.mdx) | 是 | 成员信息 | ### 返回结果 ### 代码示例 ```java showLineNumbers - OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupID, userID, ex, new OnBase() { +OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase() { @Override public void onError(int code, String error) { - + // todo: 处理错误信息 } - @Override public void onSuccess(String data) { - + // 请求成功 } }); ``` diff --git a/docs/sdks/api/relation/getFriendList.mdx b/docs/sdks/api/relation/getFriendList.mdx index 007e9357df..aed78606d9 100644 --- a/docs/sdks/api/relation/getFriendList.mdx +++ b/docs/sdks/api/relation/getFriendList.mdx @@ -99,7 +99,7 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 函数原型 ```java showLineNumbers - public void getFriendListByFilterBlack(OnBase> base, Boolean filterBlack) + public void getFriendList(OnBase> base, Boolean filterBlack) ``` ### 输入参数 @@ -117,7 +117,7 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 代码示例 ```java showLineNumbers -OpenIMClient.getInstance().friendshipManager.getFriendListByFilterBlack(new OnBase>() { +OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>() { @Override public void onError(int code, String error) { // todo: 处理错误信息 diff --git a/docs/sdks/api/relation/getFriendListPage.mdx b/docs/sdks/api/relation/getFriendListPage.mdx index e08cbf85ce..0043de6d0a 100644 --- a/docs/sdks/api/relation/getFriendListPage.mdx +++ b/docs/sdks/api/relation/getFriendListPage.mdx @@ -115,7 +115,7 @@ onSuccess:^(NSArray * _Nullable userInfos) { ### 函数原型 ```java showLineNumbers -public void getFriendListPageByFilterBlack(OnBase> base, int offset, int count, Boolean filterBlack) +public void getFriendListPage(OnBase> base, int offset, int count, Boolean filterBlack) ``` ### 输入参数 @@ -136,7 +136,7 @@ public void getFriendListPageByFilterBlack(OnBase> base, int offs ```java showLineNumbers -OpenIMClient.getInstance().friendshipManager.getFriendListPageByFilterBlack(new OnBase>() { +OpenIMClient.getInstance().friendshipManager.getFriendListPage(new OnBase>() { @Override public void onError(int code, String error) { // todo: 处理错误信息 diff --git a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx index cb9546425f..6467eb7c93 100644 --- a/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx +++ b/docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx @@ -107,7 +107,7 @@ values={[ ### 函数原型 ```java showLineNumbers -public void getFriendsInfoByFilterBlack(OnBase> base, List uidList, Boolean filterBlack) +public void getFriendsInfo(OnBase> base, List uidList, Boolean filterBlack) ``` ### 输入参数 @@ -121,7 +121,7 @@ public void getFriendsInfoByFilterBlack(OnBase> base, List>() { +OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase>() { @Override public void onError(int code, String error) { // todo: 处理错误信息 From 8522d212f6e953e1b37ddcbeede58de77cbb2c37 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 29 Sep 2024 18:23:10 +0800 Subject: [PATCH 03/10] docs: update en docs --- docs/sdks/api/group/setGroupMemberInfo.mdx | 2 +- docs/sdks/api/user/getUsersInfo.mdx | 1 - docs/sdks/class/group/SetGroupMemberInfo.mdx | 15 +++ .../api/conversation/setConversation.mdx | 31 +++++- .../current/api/group/setGroupMemberInfo.mdx | 13 +-- .../current/api/relation/getFriendList.mdx | 19 ++-- .../api/relation/getFriendListPage.mdx | 21 ++--- .../api/relation/getSpecifiedFriendsInfo.mdx | 31 +++--- .../current/api/relation/updateFriends.mdx | 32 +++++-- .../current/api/user/getUsersInfo.mdx | 29 +++--- .../current/api/user/setSelfInfo.mdx | 32 ++++--- .../class/conversation/conversationReq.mdx | 8 ++ .../class/group/SetGroupMemberInfo.mdx | 16 ++++ .../class/relation/updateFriendsReq.mdx | 94 +++++++++++++++++++ 14 files changed, 257 insertions(+), 87 deletions(-) create mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/updateFriendsReq.mdx diff --git a/docs/sdks/api/group/setGroupMemberInfo.mdx b/docs/sdks/api/group/setGroupMemberInfo.mdx index 91d3f36955..67a614cf34 100644 --- a/docs/sdks/api/group/setGroupMemberInfo.mdx +++ b/docs/sdks/api/group/setGroupMemberInfo.mdx @@ -131,7 +131,7 @@ OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase } @Override public void onSuccess(String data) { - // 请求成功 + // todo: 请求成功 } }); ``` diff --git a/docs/sdks/api/user/getUsersInfo.mdx b/docs/sdks/api/user/getUsersInfo.mdx index 80b29e980f..7a4c0b3a82 100644 --- a/docs/sdks/api/user/getUsersInfo.mdx +++ b/docs/sdks/api/user/getUsersInfo.mdx @@ -121,7 +121,6 @@ public void getUsersInfo(OnBase> callBack, List uid | -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ | | callBack | [OnBase](docs/sdks/callback/onBase.mdx)> | 是 | 回调接口 | | uidList | List | 是 | 用户 ID 集合 | -| groupID | String | false | 群ID | ### 返回结果 ### 代码示例 diff --git a/docs/sdks/class/group/SetGroupMemberInfo.mdx b/docs/sdks/class/group/SetGroupMemberInfo.mdx index 1a595c91bf..631c3399dc 100644 --- a/docs/sdks/class/group/SetGroupMemberInfo.mdx +++ b/docs/sdks/class/group/SetGroupMemberInfo.mdx @@ -57,6 +57,21 @@ values={[ + + +### SetGroupMemberInfo + +| 字段名称 | 字段类型 | 描述 | +| -------------- | -------------------------------------------------- | ----------------- | +| groupID | String | 群 ID | +| userID | String | 群成员 ID | +| nickname | String | 群成员昵称 | +| faceURL | String | 群成员头像 | +| roleLevel | Integer | 群成员角色, 1 普通成员；2 群主；3 管理员 | +| ex | String | | + + + ### SetGroupMemberInfo diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversation.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversation.mdx index 3b09d82198..64d88fd1bb 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversation.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversation.mdx @@ -56,11 +56,36 @@ To be updated. -:::info Description +### Function Prototype -To be updated. +```java showLineNumbers +public void setConversation(OnBase base, String conversationID, ConversationReq conversationReq) +``` + +### Input Parameters + +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | -------- | -------- | ------- | +| conversationID | String | Yes | conversation ID | +| conversationReq | [ConversationReq](/class/conversation/conversationReq.mdx) | Yes | conversation request info | + +### Return Value + +### Code Example + +```java showLineNumbers +OpenIMClient.getInstance().conversationManager.setConversation(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: request error + } + @Override + public void onSuccess(String data) { + // todo: request success + } +}, conversationID , conversationReq); +``` -::: diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/group/setGroupMemberInfo.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/group/setGroupMemberInfo.mdx index 9e6d2f39c5..a7c1e49db3 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/group/setGroupMemberInfo.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/group/setGroupMemberInfo.mdx @@ -122,31 +122,28 @@ values={[ ### Function Prototype ```java showLineNumbers - public void setGroupMemberInfo(String groupID,String userID,String ex,OnBase callBack)) +public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase callBack) ``` ### Input Parameters | Parameter Name | Parameter Type | Required | Description | | -------------- | -------------- | -------- | -----------------| -| groupID | String | Yes | Group ID | -| userID | String | Yes | User ID | -| ex | String | Yes | Member Extended Info | +| groupMembersInfo | [SetGroupMemberInfo](/class/group/SetGroupMemberInfo.mdx) | Yes | Group ID | ### Return Result ### Code Example ```java showLineNumbers - OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupID, userID, ex, new OnBase() { +OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase() { @Override public void onError(int code, String error) { - + // todo: request error } - @Override public void onSuccess(String data) { - + // todo: requset success } }); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendList.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendList.mdx index 8eac371ab3..ff091d68e6 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendList.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendList.mdx @@ -94,15 +94,15 @@ None ```java showLineNumbers - public void getFriendList(OnBase> callBack) + public void getFriendList(OnBase> base, Boolean filterBlack) ``` ### Input Parameters -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------------------------- | --------- | ----------- | -| callBack | [OnBase](/callback/onBase.mdx)> | Yes | Callback | +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | ------------------ | --------- | ----------- | +| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. | ### Return Values @@ -113,19 +113,16 @@ None ### Code Example ```java showLineNumbers - -OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>(){ +OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>() { @Override public void onError(int code, String error) { - + // todo: request error } - @Override public void onSuccess(List data) { - + // todo: request success } -}) - +}, filterBlack); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendListPage.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendListPage.mdx index db03ceda7e..6d9631d339 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendListPage.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendListPage.mdx @@ -97,15 +97,17 @@ None ```java showLineNumbers - public void getFriendList(OnBase> callBack) +public void getFriendListPage(OnBase> base, int offset, int count, Boolean filterBlack) ``` ### Input Parameters -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------------------------- | --------- | ----------- | -| callBack | [OnBase](/callback/onBase.mdx)> | Yes | Callback | +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | ------------------- | -------------- | ----------- | +| offset | int | Yes | page offset | +| count | int | Yes | page size | +| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. | ### Return Values @@ -116,19 +118,16 @@ None ### Code Example ```java showLineNumbers - -OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase>(){ +OpenIMClient.getInstance().friendshipManager.getFriendListPage(new OnBase>() { @Override public void onError(int code, String error) { - + // todo: request error } - @Override public void onSuccess(List data) { - + // todo: request success } -}) - +}, filterBlack); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getSpecifiedFriendsInfo.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getSpecifiedFriendsInfo.mdx index 2cad93a11d..830f29c809 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getSpecifiedFriendsInfo.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getSpecifiedFriendsInfo.mdx @@ -99,30 +99,29 @@ values={[ ### Function Prototype ```java showLineNumbers - public void getFriendsInfo(OnBase> base, List uidList) +public void getFriendsInfo(OnBase> base, List uidList, Boolean filterBlack) ``` ### Input Parameters -| Parameter Name | Data Type | Required | Description | -| -------------- | ------------------------------------------------------------------------- | -------- | -------------- | -| callBack | [OnBase](/callback/onBase.mdx)> | Yes | Callback method | -| uidList | List | Yes | List of user IDs | +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | ------------------- | -------------- | ----------- | +| uidList | List | Yes | List of user IDs | +| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. | ### Code Example ```java showLineNumbers - OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase>() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(List data) { - - } - },uidList); +OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase>() { + @Override + public void onError(int code, String error) { + // todo: request error + } + @Override + public void onSuccess(List data) { + // todo: request success + } +}, uidList, filterBlack); ``` 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 857ebf144b..f0644d5570 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 @@ -57,12 +57,32 @@ To be updated. -:::info Description - -To be updated. - -::: - +```java showLineNumbers +public void updateFriendsReq(OnBase base, UpdateFriendsReq updateFriendsReq) +``` + +### Input Parameters + +| Parameter Name | Parameter Type | Required | Description | +| -------------- | -------- | -------- | ------- | +| updateFriendsReq | [UpdateFriendsReq](/class/relation/updateFriendsReq.mdx) | Yes | friend info | + +### Return Result + +### Code Example + +```java showLineNumbers +OpenIMClient.getInstance().friendshipManager.updateFriendsReq(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: request error + } + @Override + public void onSuccess(String data) { + // todo: request success + } +}, updateFriendsReq); +``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/getUsersInfo.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/getUsersInfo.mdx index fc4fb555d1..0a4486ddd8 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/getUsersInfo.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/getUsersInfo.mdx @@ -118,35 +118,30 @@ await OpenIM.iMManager.userManager.getUsersInfoWithCache([], ''); ### Function Prototype ```java showLineNumbers - -public void getUsersInfoWithCache(OnBase> callBack, List uidList,String groupID) - +public void getUsersInfo(OnBase> callBack, List uidList) ``` ### Input Parameters | Parameter Name | Data Type | Mandatory | Description | | -------------- | --------------------------------------------------------------------------------- | --------- | ------------ | -| callBack | [OnBase](/callback/onBase.mdx)> | Yes | Callback | +| callBack | [OnBase](/callback/onBase.mdx)> | Yes | Callback | | uidList | List | Yes | List of user IDs | -| groupID | String | No | Group ID | - ### Return Value ### Code Example ```java showLineNumbers - OpenIMClient.getInstance().userInfoManager.getUsersInfoWithCache(new OnBase>() { - @Override - public void onError(int code, String error) { - - } - - @Override - public void onSuccess(List data) { - - } - },uidList,groupId); +OpenIMClient.getInstance().userInfoManager.getUsersInfo(new OnBase>() { + @Override + public void onError(int code, String error) { + // todo: request error + } + @Override + public void onSuccess(List data) { + // todo: request success + } +},uidList); ``` 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 cd50264d8d..de4283476a 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 @@ -121,21 +121,18 @@ info.faceURL = @""; ### Function Prototype ```java showLineNumbers - - public void setSelfInfo(OnBase callBack, String nickname, String faceURL, int appMangerLevel, String ex) - + public void setSelfInfo(OnBase base, UserInfoReq userInfoReq) ``` ### 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 | +UserInfoReq: +| Parameter Name | Parameter Type | Mandatory | Description | +| ---------------- | ------------------------------------ | --------- | ------------------------------------ | +| userID | String | Yes | Name | +| nickname | String | No | Nickname | +| faceURL | String | No | Avatar | +| ex | String | No | Internal field, can be ignored | +| globalRecvMsgOpt | Integer | No | Global Do Not Disturb 0: Normal; 1: Do not receive messages; 2: Receive online messages but not offline messages | ### Return Result @@ -143,7 +140,16 @@ info.faceURL = @""; ```java showLineNumbers -OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase(){…},...); +OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase(){ + @Override + public void onError(int code, String error) { + // todo: request error + } + @Override + public void onSuccess(String data) { + // todo: request success + } +},userInfoReq); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx index 16b19eb3f3..e4b1582080 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx @@ -60,6 +60,14 @@ values={[ ### ConversationReq +| Field Name | Field Type | Description | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | Receive Message Disturbance Options: 0: Normal; 1: No messages; 2: Online messages only | +| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @ Type | +| isPinned | boolean | Is Pinned | +| isPrivateChat | boolean | Private Chat enabled (read & burn) | +| burnDuration | int | Burn Duration after reading (seconds) | +| ex | String | Extension Field | diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/group/SetGroupMemberInfo.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/group/SetGroupMemberInfo.mdx index b22afa704c..593189a482 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/group/SetGroupMemberInfo.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/group/SetGroupMemberInfo.mdx @@ -17,10 +17,26 @@ Set Group Memeber Info + + +### SetGroupMemberInfo + +| Field Name | Field Type | Description | +| -----------------| ----------------| -------------------------| +| groupID | string | Group ID | +| userID | string | User ID | +| nickname | string | Group Memeber Nickname | +| faceURL | string | Group Member Face | +| roleLevel | Integer | Group Member Role | +| ex | string | Group Member Extension | + + + ### SetGroupMemberInfo diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/updateFriendsReq.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/updateFriendsReq.mdx new file mode 100644 index 0000000000..58277b48e0 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/relation/updateFriendsReq.mdx @@ -0,0 +1,94 @@ +--- +sidebar_position: 6 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# UpdateFriendsReq + +## Feature Introduction + +:::info + +updated your friend information + +::: + + + + + +### UpdateFriendsReq + +| Parameter Name | Parameter Type | Description | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| remark | String | It will remark your friend's name | +| isPinned | bool | If true you will pinned the friend on the top | +| friendUserIDs | List< String\> | Your friends' list of userid | +| ex | String | Extension Field | + + + + + +### OIMUpdateFriendsReq + +| Parameter Name | Parameter Type | Description | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| remark | NSString | It will remark your friend's name | +| isPinned | BOOL | If true you will pinned the friend on the top | +| friendUserIDs | NSArray< String\> | Your friends' list of userid | +| ex | NSString | Extension Field | + + + + + +### UpdateFriendsReq + +| Parameter Name | Parameter Type | Description | +| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| remark | String | It will remark your friend's name | +| isPinned | Boolean | If true you will pinned the friend on the top | +| friendUserIDs | String[] | Your friends' list of userid | +| ex | String | Extension Field | + + + + + + +### ConversationReq + + + + + +### ConversationReq + + + + + +### ConversationReq + + + + + +### ConversationReq + + + + From fba8e0175c3bb7a680d4c3dc007539dfabb625f0 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 29 Sep 2024 18:30:33 +0800 Subject: [PATCH 04/10] fix: fix some error --- docs/sdks/class/conversation/conversationReq.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sdks/class/conversation/conversationReq.mdx b/docs/sdks/class/conversation/conversationReq.mdx index 41f51dc5c8..984382e52a 100644 --- a/docs/sdks/class/conversation/conversationReq.mdx +++ b/docs/sdks/class/conversation/conversationReq.mdx @@ -60,10 +60,10 @@ values={[ | 字段名称 | 字段类型 | 描述 | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 | -| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @类型 | -| isPinned | boolean | 是否置顶 | -| isPrivateChat | boolean | 是否开启了阅后即焚 | +| recvMsgOpt | int | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 | +| groupAtType | int | @类型 | +| isPinned | boolean | 是否置顶 | +| isPrivateChat | boolean | 是否开启了阅后即焚 | | burnDuration | int | 阅后即焚时间（秒） | | ex | String | 扩展字段 | From 55923e0554a3b99497c0371af094eaba02192f3b Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 29 Sep 2024 18:59:21 +0800 Subject: [PATCH 05/10] fix: link error --- .../current/class/conversation/conversationReq.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx index e4b1582080..b8888fc0ca 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/class/conversation/conversationReq.mdx @@ -62,8 +62,8 @@ values={[ ### ConversationReq | Field Name | Field Type | Description | | ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- | -| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | Receive Message Disturbance Options: 0: Normal; 1: No messages; 2: Online messages only | -| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @ Type | +| recvMsgOpt | [int](/enum/recvMsgOpt.mdx) | Receive Message Disturbance Options: 0: Normal; 1: No messages; 2: Online messages only | +| groupAtType | [int](/enum/groupAtType.mdx) | @ Type | | isPinned | boolean | Is Pinned | | isPrivateChat | boolean | Private Chat enabled (read & burn) | | burnDuration | int | Burn Duration after reading (seconds) | From 1e67219fed0b5cf01d1ec256b789048dc60c97ec Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 9 Oct 2024 16:16:34 +0800 Subject: [PATCH 06/10] docs: update api doc about android --- .../api/conversation/changeInputStates.mdx | 30 +++++++++++++++++++ docs/sdks/api/conversation/getInputStates.mdx | 30 +++++++++++++++++++ .../api/conversation/changeInputStates.mdx | 22 +++++--------- .../api/conversation/getInputStates.mdx | 22 +++++--------- 4 files changed, 74 insertions(+), 30 deletions(-) diff --git a/docs/sdks/api/conversation/changeInputStates.mdx b/docs/sdks/api/conversation/changeInputStates.mdx index d0aaa28cda..2ac80308d7 100644 --- a/docs/sdks/api/conversation/changeInputStates.mdx +++ b/docs/sdks/api/conversation/changeInputStates.mdx @@ -112,6 +112,36 @@ Future changeInputStates({ +### 函数原型 + +```java showLineNumbers +public void changeInputState(OnBase base, String conversionId, boolean focus) +``` + +### 输入参数 + +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------------- | -------- | -------- | ------- | +| conversationID | String | 是 | 会话 ID | +| focus | boolean | 是 | 是否正在输入 | + +### 返回结果 + +### 代码示例 + +```java showLineNumbers +OpenIMClient.getInstance().conversationManager.changeInputState(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(String data) { + // todo: 请求成功 + } +}, conversationID , focus); +``` + diff --git a/docs/sdks/api/conversation/getInputStates.mdx b/docs/sdks/api/conversation/getInputStates.mdx index cd458ab582..6f4731b203 100644 --- a/docs/sdks/api/conversation/getInputStates.mdx +++ b/docs/sdks/api/conversation/getInputStates.mdx @@ -107,6 +107,36 @@ Future getInputstates({ +### 函数原型 + +```java showLineNumbers +public void getInputState(OnBase base, String conversionId, String userId) +``` + +### 输入参数 + +| 参数名称 | 参数类型 | 是否必填 | 描述 | +| -------------- | -------- | -------- | ------- | +| conversationID | String | 是 | 会话 ID | +| userId | String | 是 | 用户ID | + +### 返回结果 + +### 代码示例 + +```java showLineNumbers +OpenIMClient.getInstance().conversationManager.getInputState(new OnBase() { + @Override + public void onError(int code, String error) { + // todo: 处理错误信息 + } + @Override + public void onSuccess(String data) { + // todo: 请求成功 + } +}, conversationID , userId); +``` + diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/changeInputStates.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/changeInputStates.mdx index d32a28ce1f..9cf7ce49ae 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/changeInputStates.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/changeInputStates.mdx @@ -115,9 +115,7 @@ Future changeInputStates({ ### Function Prototype ```java showLineNumbers -public void changeInputStates(String conversationID, boolean focus, OIMSuccessCallback onSuccess, OIMFailureCallback onFailure) { - // implementation -} +public void changeInputState(OnBase base, String conversionId, boolean focus) ``` ### Input Parameters @@ -129,25 +127,19 @@ public void changeInputStates(String conversationID, boolean focus, OIMSuccessCa ### Return Result -| Name | Type | Description | -| --------- | --------------------- | -------------- | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - ### Code Example ```java showLineNumbers -changeInputStates(conversationID, focus, new OIMSuccessCallback() { +OpenIMClient.getInstance().conversationManager.changeInputState(new OnBase() { @Override - public void onSuccess(String data) { - // handle success + public void onError(int code, String error) { + // todo: handle success } -}, new OIMFailureCallback() { @Override - public void onFailure(int code, String msg) { - // handle failure + public void onSuccess(String data) { + // todo: request fail } -}); +}, conversationID , focus); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx index 2f6947731f..42ca469f93 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx @@ -109,9 +109,7 @@ Future getInputstates({ ### Function Prototype ```java showLineNumbers -public void getInputStates(String conversationID, String userID, OIMSuccessCallback onSuccess, OIMFailureCallback onFailure) { - // implementation -} +public void getInputState(OnBase base, String conversionId, String userId) ``` ### Input Parameters @@ -123,25 +121,19 @@ public void getInputStates(String conversationID, String userID, OIMSuccessCallb ### Return Result -| Name | Type | Description | -| --------- | --------------------- | -------------- | -| onSuccess | OIMSuccessCallback | Success return | -| onFailure | OIMFailureCallback | Failure return | - ### Code Example ```java showLineNumbers -getInputStates(conversationID, userID, new OIMSuccessCallback() { +OpenIMClient.getInstance().conversationManager.getInputState(new OnBase() { @Override - public void onSuccess(String data) { - // handle success + public void onError(int code, String error) { + // todo: handle success } -}, new OIMFailureCallback() { @Override - public void onFailure(int code, String msg) { - // handle failure + public void onSuccess(String data) { + // todo: request fail } -}); +}, conversationID , userId); ``` From 79c76ae8e0886591fc4a4cee900eca263a09f9a9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 9 Oct 2024 17:51:21 +0800 Subject: [PATCH 07/10] fix: fix doc error --- docs/sdks/api/conversation/getInputStates.mdx | 6 +++--- .../current/api/conversation/getInputStates.mdx | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sdks/api/conversation/getInputStates.mdx b/docs/sdks/api/conversation/getInputStates.mdx index 6f4731b203..94d922bf1e 100644 --- a/docs/sdks/api/conversation/getInputStates.mdx +++ b/docs/sdks/api/conversation/getInputStates.mdx @@ -110,7 +110,7 @@ Future getInputstates({ ### 函数原型 ```java showLineNumbers -public void getInputState(OnBase base, String conversionId, String userId) +public void getInputState(OnBase> base, String conversionId, String userId) ``` ### 输入参数 @@ -125,13 +125,13 @@ public void getInputState(OnBase base, String conversionId, String userI ### 代码示例 ```java showLineNumbers -OpenIMClient.getInstance().conversationManager.getInputState(new OnBase() { +OpenIMClient.getInstance().conversationManager.getInputState(new OnBase>() { @Override public void onError(int code, String error) { // todo: 处理错误信息 } @Override - public void onSuccess(String data) { + public void onSuccess(List data) { // todo: 请求成功 } }, conversationID , userId); diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx index 42ca469f93..96be6aad66 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/getInputStates.mdx @@ -109,7 +109,7 @@ Future getInputstates({ ### Function Prototype ```java showLineNumbers -public void getInputState(OnBase base, String conversionId, String userId) +public void getInputState(OnBase> base, String conversionId, String userId) ``` ### Input Parameters @@ -124,13 +124,13 @@ public void getInputState(OnBase base, String conversionId, String userI ### Code Example ```java showLineNumbers -OpenIMClient.getInstance().conversationManager.getInputState(new OnBase() { +OpenIMClient.getInstance().conversationManager.getInputState(new OnBase>() { @Override public void onError(int code, String error) { // todo: handle success } @Override - public void onSuccess(String data) { + public void onSuccess(List data) { // todo: request fail } }, conversationID , userId); From ce316cb2c6d4651545bc69d9b395e7aa78ed2b41 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 9 Jan 2025 18:02:53 +0800 Subject: [PATCH 08/10] docs: update android offline config --- docs/guides/solution/offlinePush.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/solution/offlinePush.mdx b/docs/guides/solution/offlinePush.mdx index b352ab9f4a..83f035189b 100644 --- a/docs/guides/solution/offlinePush.mdx +++ b/docs/guides/solution/offlinePush.mdx @@ -44,4 +44,5 @@ enable: #选择 getui 或者 fcm - [OpenIM Flutter Demo 配置说明](https://github.com/openimsdk/openim-flutter-demo/blob/main/CONFIGKEY.zh-CN.md) - [OpenIM iOS Demo 配置说明](https://github.com/openimsdk/openim-ios-demo/blob/main/CONFIGKEY.zh-CN.md) - [OpenIM Uniapp Demo 配置说明](https://github.com/openimsdk/open-im-uniapp-demo/blob/main/CONFIGKEY.md) +- [OpenIM Android Demo 配置说明](https://github.com/openimsdk/open-im-android-demo/blob/main/CONFIGKEY.zh-CN.md) From 1abafba56b2a1d9a50f6aafb01af3b58d46dadf1 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 10 Jan 2025 15:48:20 +0800 Subject: [PATCH 09/10] docs: update new parameter for v3.8.3 --- .../message/getAdvancedHistoryMessageList.mdx | 13 +- .../getAdvancedHistoryMessageListReverse.mdx | 11 +- docs/sdks/enum/viewType.mdx | 109 +++++++++++++++++ .../message/getAdvancedHistoryMessageList.mdx | 21 ++-- .../getAdvancedHistoryMessageListReverse.mdx | 11 +- .../current/enum/viewType.mdx | 111 ++++++++++++++++++ 6 files changed, 250 insertions(+), 26 deletions(-) create mode 100644 docs/sdks/enum/viewType.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx index 77bd7a2d2e..9b0b689e36 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageList.mdx @@ -119,22 +119,23 @@ opts.lastMinSeq = @""; ### 函数原型 -```dart showLineNumbers - public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### 输入参数 | 参数名称 | 参数类型 | 是否必填 | 描述 | -| -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | +| -------------- | -------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------| | callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 | | conversationID | Sting | 是 | 会话 ID | -| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | +| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | | count | int | 是 | 数量 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 | ### 代码示例 -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); // todo ``` diff --git a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx index c46158a8bf..0b788c4626 100644 --- a/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -119,8 +119,8 @@ opts.lastMinSeq = @""; ### 函数原型 -```dart showLineNumbers - public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### 输入参数 @@ -129,12 +129,13 @@ opts.lastMinSeq = @""; | -------------- | -------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | | callBack | OnBase<[AdvancedMessage](docs/sdks/class/message/advancedHistoryInfo.mdx)> | 是 | 回调接口 | | conversationID | Sting | 是 | 会话 ID | -| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | +| startMsg | [Message](docs/sdks/class/message/messageInfo.mdx) | 是 | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | | count | int | 是 | 数量 | +| viewType | [ViewType](docs/sdks/enum/viewType.mdx) | 是 | 为History时表示当前在获取历史消息，为Search时表示在执行搜索消息操作 | ### 代码示例 -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); ``` diff --git a/docs/sdks/enum/viewType.mdx b/docs/sdks/enum/viewType.mdx new file mode 100644 index 0000000000..e4fb0480f0 --- /dev/null +++ b/docs/sdks/enum/viewType.mdx @@ -0,0 +1,109 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# ViewType + +:::info + +在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse)时，客户端用于通知SDK当前的具体操作。 + +::: + +## 当前操作类型 + +| 枚举值 | 描述 | +| ------ | ----------- | +| 0 | 拉取历史消息 | +| 1 | 搜索历史消息 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| ---------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| 枚举值名称 | 枚举值 | +| --------- | ------ | +| History | 0 | +| Search | 1 | + + + + diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx index b8737826ac..0a8c8d199b 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageList.mdx @@ -119,22 +119,23 @@ opts.lastMinSeq = @""; ### Function Prototype -```dart showLineNumbers - public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageList(OnBase callBack, String conversationID, Message startMsg, int count, ViewType viewType) ``` ### Input Parameters -| Parameter Name | Parameter Type | Mandatory | Description | -| -------------- | ----------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------| -| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | -| conversationID | String | Yes | Conversation ID | -| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message | -| count | int | Yes | Number of messages | +| Parameter Name | Parameter Type | Mandatory | Description | +| -------------- | ----------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------| +| callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | +| conversationID | String | Yes | Conversation ID | +| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Query [count] messages starting from this message, index==length-1 is the latest message | +| count | int | Yes | Number of messages | +| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. | ### Code Example -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageList(new OnBase() { @Override public void onError(int code, String error) { @@ -145,7 +146,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); // todo ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx index 1637ec7281..1419bf03d7 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/api/message/getAdvancedHistoryMessageListReverse.mdx @@ -121,8 +121,8 @@ opts.lastMinSeq = @""; ### Function Prototype -```dart showLineNumbers - public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count) +```java showLineNumbers + public void getAdvancedHistoryMessageListReverse(OnBase callBack, String conversationID, Message startMsg, int count, ViewType) ``` ### Input Parameters @@ -131,12 +131,13 @@ opts.lastMinSeq = @""; | -------------- | -------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | | callBack | OnBase<[AdvancedMessage](/class/message/advancedHistoryInfo.mdx)> | Yes | Callback interface | | conversationID | Sting | Yes | Conversation ID | -| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Start querying [count] from this message. Index==length-1 is the latest message, so for the next page of historical records, startMsg=list.first | +| startMsg | [Message](/class/message/messageInfo.mdx) | Yes | Start querying [count] from this message. Index==length-1 is the latest message, so for the next page of historical records, startMsg=list.first | | count | int | Yes | Number of messages to retrieve in one fetch | +| viewType | ViewType(/enum/viewType.mdx) | Yes | If you get the historical message, use ViewType.History. If you search the message, use ViewType.Search. | ### Code Example -```dart showLineNumbers +```java showLineNumbers OpenIMClient.getInstance().messageManager. getAdvancedHistoryMessageListReverse(new OnBase() { @Override public void onError(int code, String error) { @@ -147,7 +148,7 @@ opts.lastMinSeq = @""; public void onSuccess(AdvancedMessage data) { } - } conversationID, startMsg, count); + } conversationID, startMsg, count, ViewType.History); ``` diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx new file mode 100644 index 0000000000..2e0dfb9cbb --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx @@ -0,0 +1,111 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# ViewType + +:::info + +When use the api of [getAdvancedHistoryMessageList](/api/message/getAdvancedHistoryMessageList) or [getAdvancedHistoryMessageListReverse](/api/message/getAdvancedHistoryMessageListReverse), used to notify the SDK of the current specific operation. + +::: + +## Type of operation about get message list + +| Enum Value | Description | +| ---------- | ------------------------------------- | +| 0 | used for getting historical message | +| 1 | used for searching message | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + + +### ViewType + +| Enum Name | Enum Value | +| --------- | ---------- | +| History | 0 | +| Search | 1 | + + + + From 749706d8996c09810fca6e09555c1b024433631e Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 10 Jan 2025 15:57:31 +0800 Subject: [PATCH 10/10] fix: doc path reference error --- docs/sdks/enum/viewType.mdx | 2 +- .../current/enum/viewType.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sdks/enum/viewType.mdx b/docs/sdks/enum/viewType.mdx index e4fb0480f0..f46565a46a 100644 --- a/docs/sdks/enum/viewType.mdx +++ b/docs/sdks/enum/viewType.mdx @@ -8,7 +8,7 @@ toc_max_heading_level: 2 :::info -在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse)时，客户端用于通知SDK当前的具体操作。 +在[获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageList.mdx)与[反向获取会话历史消息](docs/sdks/api/message/getAdvancedHistoryMessageListReverse.mdx)时，客户端用于通知SDK当前的具体操作。 ::: diff --git a/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx index 2e0dfb9cbb..2dee217785 100644 --- a/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx +++ b/i18n/en/docusaurus-plugin-content-docs-sdks/current/enum/viewType.mdx @@ -8,7 +8,7 @@ toc_max_heading_level: 2 :::info -When use the api of [getAdvancedHistoryMessageList](/api/message/getAdvancedHistoryMessageList) or [getAdvancedHistoryMessageListReverse](/api/message/getAdvancedHistoryMessageListReverse), used to notify the SDK of the current specific operation. +When use the api of [getAdvancedHistoryMessageList](/api/message/getAdvancedHistoryMessageList.mdx) or [getAdvancedHistoryMessageListReverse](/api/message/getAdvancedHistoryMessageListReverse.mdx), used to notify the SDK of the current specific operation. :::