Skip to content

Commit 8522d21

Browse files
JauneQJauneQ
committed
docs: update en docs
1 parent f7b7f01 commit 8522d21

14 files changed

Lines changed: 257 additions & 87 deletions

File tree

‎docs/sdks/api/group/setGroupMemberInfo.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase
131131
}
132132
@Override
133133
public void onSuccess(String data) {
134-
// 请求成功
134+
// todo: 请求成功
135135
}
136136
});
137137
```

‎docs/sdks/api/user/getUsersInfo.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,6 @@ public void getUsersInfo(OnBase<List<PublicUserInfo>> callBack, List<String> uid
121121
| -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ |
122122
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[PublicUserInfo](docs/sdks/class/user/publicInfo.mdx)>> | 是 | 回调接口 |
123123
| uidList | List<String\> | 是 | 用户 ID 集合 |
124-
| groupID | String | false | 群ID |
125124
### 返回结果
126125

127126
### 代码示例

‎docs/sdks/class/group/SetGroupMemberInfo.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,21 @@ values={[
5757

5858
</TabItem>
5959

60+
<TabItem value="Android">
61+
62+
### SetGroupMemberInfo
63+
64+
| 字段名称 | 字段类型 | 描述 |
65+
| -------------- | -------------------------------------------------- | ----------------- |
66+
| groupID | String | 群 ID |
67+
| userID | String | 群成员 ID |
68+
| nickname | String | 群成员昵称 |
69+
| faceURL | String | 群成员头像 |
70+
| roleLevel | Integer | 群成员角色, 1 普通成员；2 群主；3 管理员 |
71+
| ex | String | |
72+
73+
</TabItem>
74+
6075
<TabItem value="Unity">
6176

6277
### SetGroupMemberInfo

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/conversation/setConversation.mdx‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,36 @@ To be updated.
5656

5757
<TabItem value="Android">
5858

59-
:::info Description
59+
### Function Prototype
6060

61-
To be updated.
61+
```java showLineNumbers
62+
public void setConversation(OnBase<String> base, String conversationID, ConversationReq conversationReq)
63+
```
64+
65+
### Input Parameters
66+
67+
| Parameter Name | Parameter Type | Mandatory | Description |
68+
| -------------- | -------- | -------- | ------- |
69+
| conversationID | String | Yes | conversation ID |
70+
| conversationReq | [ConversationReq](/class/conversation/conversationReq.mdx) | Yes | conversation request info |
71+
72+
### Return Value
73+
74+
### Code Example
75+
76+
```java showLineNumbers
77+
OpenIMClient.getInstance().conversationManager.setConversation(new OnBase<String>() {
78+
@Override
79+
public void onError(int code, String error) {
80+
// todo: request error
81+
}
82+
@Override
83+
public void onSuccess(String data) {
84+
// todo: request success
85+
}
86+
}, conversationID , conversationReq);
87+
```
6288

63-
:::
6489

6590
</TabItem>
6691

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/group/setGroupMemberInfo.mdx‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -122,31 +122,28 @@ values={[
122122
### Function Prototype
123123

124124
```java showLineNumbers
125-
public void setGroupMemberInfo(String groupID,String userID,String ex,OnBase<String> callBack))
125+
public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase<String> callBack)
126126
```
127127

128128
### Input Parameters
129129

130130
| Parameter Name | Parameter Type | Required | Description |
131131
| -------------- | -------------- | -------- | -----------------|
132-
| groupID | String | Yes | Group ID |
133-
| userID | String | Yes | User ID |
134-
| ex | String | Yes | Member Extended Info |
132+
| groupMembersInfo | [SetGroupMemberInfo](/class/group/SetGroupMemberInfo.mdx) | Yes | Group ID |
135133

136134
### Return Result
137135

138136
### Code Example
139137

140138
```java showLineNumbers
141-
OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupID, userID, ex, new OnBase<String>() {
139+
OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase<String>() {
142140
@Override
143141
public void onError(int code, String error) {
144-
142+
// todo: request error
145143
}
146-
147144
@Override
148145
public void onSuccess(String data) {
149-
146+
// todo: requset success
150147
}
151148
});
152149
```

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendList.mdx‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ None
9494

9595
```java showLineNumbers
9696

97-
public void getFriendList(OnBase<List<UserInfo>> callBack)
97+
public void getFriendList(OnBase<List<UserInfo>> base, Boolean filterBlack)
9898

9999
```
100100

101101
### Input Parameters
102102

103-
| Parameter Name | Parameter Type | Mandatory | Description |
104-
| -------------- | ----------------------------------------------------------------------- | --------- | ----------- |
105-
| callBack | [OnBase](/callback/onBase.mdx)<List<[UserInfo](/class/user/userInfo.mdx)>> | Yes | Callback |
103+
| Parameter Name | Parameter Type | Mandatory | Description |
104+
| -------------- | ------------------ | --------- | ----------- |
105+
| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. |
106106

107107
### Return Values
108108

@@ -113,19 +113,16 @@ None
113113
### Code Example
114114

115115
```java showLineNumbers
116-
117-
OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>(){
116+
OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>() {
118117
@Override
119118
public void onError(int code, String error) {
120-
119+
// todo: request error
121120
}
122-
123121
@Override
124122
public void onSuccess(List<UserInfo> data) {
125-
123+
// todo: request success
126124
}
127-
})
128-
125+
}, filterBlack);
129126
```
130127

131128
</TabItem>

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getFriendListPage.mdx‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,17 @@ None
9797

9898
```java showLineNumbers
9999

100-
public void getFriendList(OnBase<List<UserInfo>> callBack)
100+
public void getFriendListPage(OnBase<List<UserInfo>> base, int offset, int count, Boolean filterBlack)
101101

102102
```
103103

104104
### Input Parameters
105105

106-
| Parameter Name | Parameter Type | Mandatory | Description |
107-
| -------------- | ----------------------------------------------------------------------- | --------- | ----------- |
108-
| callBack | [OnBase](/callback/onBase.mdx)<List<[UserInfo](/class/user/userInfo.mdx)>> | Yes | Callback |
106+
| Parameter Name | Parameter Type | Mandatory | Description |
107+
| -------------- | ------------------- | -------------- | ----------- |
108+
| offset | int | Yes | page offset |
109+
| count | int | Yes | page size |
110+
| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. |
109111

110112
### Return Values
111113

@@ -116,19 +118,16 @@ None
116118
### Code Example
117119

118120
```java showLineNumbers
119-
120-
OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>(){
121+
OpenIMClient.getInstance().friendshipManager.getFriendListPage(new OnBase<List<UserInfo>>() {
121122
@Override
122123
public void onError(int code, String error) {
123-
124+
// todo: request error
124125
}
125-
126126
@Override
127127
public void onSuccess(List<UserInfo> data) {
128-
128+
// todo: request success
129129
}
130-
})
131-
130+
}, filterBlack);
132131
```
133132

134133
</TabItem>

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/getSpecifiedFriendsInfo.mdx‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -99,30 +99,29 @@ values={[
9999
### Function Prototype
100100

101101
```java showLineNumbers
102-
public void getFriendsInfo(OnBase<List<UserInfo>> base, List<String> uidList)
102+
public void getFriendsInfo(OnBase<List<UserInfo>> base, List<String> uidList, Boolean filterBlack)
103103
```
104104

105105
### Input Parameters
106106

107-
| Parameter Name | Data Type | Required | Description |
108-
| -------------- | ------------------------------------------------------------------------- | -------- | -------------- |
109-
| callBack | [OnBase](/callback/onBase.mdx)<List<[UserInfo](/class/user/userInfo.mdx)>> | Yes | Callback method |
110-
| uidList | List<String\> | Yes | List of user IDs |
107+
| Parameter Name | Parameter Type | Mandatory | Description |
108+
| -------------- | ------------------- | -------------- | ----------- |
109+
| uidList | List<String\> | Yes | List of user IDs |
110+
| filterBlack | Boolean | No | if true, the return value will not be include blacklist users. |
111111

112112
### Code Example
113113

114114
```java showLineNumbers
115-
OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase<List<UserInfo>>() {
116-
@Override
117-
public void onError(int code, String error) {
118-
119-
}
120-
121-
@Override
122-
public void onSuccess(List<UserInfo> data) {
123-
124-
}
125-
},uidList);
115+
OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase<List<UserInfo>>() {
116+
@Override
117+
public void onError(int code, String error) {
118+
// todo: request error
119+
}
120+
@Override
121+
public void onSuccess(List<UserInfo> data) {
122+
// todo: request success
123+
}
124+
}, uidList, filterBlack);
126125
```
127126
</TabItem>
128127

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/relation/updateFriends.mdx‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,32 @@ To be updated.
5757

5858
<TabItem value="Android">
5959

60-
:::info Description
61-
62-
To be updated.
63-
64-
:::
65-
60+
```java showLineNumbers
61+
public void updateFriendsReq(OnBase<String> base, UpdateFriendsReq updateFriendsReq)
62+
```
63+
64+
### Input Parameters
65+
66+
| Parameter Name | Parameter Type | Required | Description |
67+
| -------------- | -------- | -------- | ------- |
68+
| updateFriendsReq | [UpdateFriendsReq](/class/relation/updateFriendsReq.mdx) | Yes | friend info |
69+
70+
### Return Result
71+
72+
### Code Example
73+
74+
```java showLineNumbers
75+
OpenIMClient.getInstance().friendshipManager.updateFriendsReq(new OnBase<String>() {
76+
@Override
77+
public void onError(int code, String error) {
78+
// todo: request error
79+
}
80+
@Override
81+
public void onSuccess(String data) {
82+
// todo: request success
83+
}
84+
}, updateFriendsReq);
85+
```
6686

6787
</TabItem>
6888

‎i18n/en/docusaurus-plugin-content-docs-sdks/current/api/user/getUsersInfo.mdx‎

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -118,35 +118,30 @@ await OpenIM.iMManager.userManager.getUsersInfoWithCache([], '');
118118
### Function Prototype
119119

120120
```java showLineNumbers
121-
122-
public void getUsersInfoWithCache(OnBase<List<UserInfo>> callBack, List<String> uidList,String groupID)
123-
121+
public void getUsersInfo(OnBase<List<PublicUserInfo>> callBack, List<String> uidList)
124122
```
125123

126124
### Input Parameters
127125

128126
| Parameter Name | Data Type | Mandatory | Description |
129127
| -------------- | --------------------------------------------------------------------------------- | --------- | ------------ |
130-
| callBack | [OnBase](/callback/onBase.mdx)<List<[UserInfo](/class/user/userInfo.mdx)>> | Yes | Callback |
128+
| callBack | [OnBase](/callback/onBase.mdx)<List<[PublicUserInfo](/class/user/publicInfo.mdx)>> | Yes | Callback |
131129
| uidList | List<String\> | Yes | List of user IDs |
132-
| groupID | String | No | Group ID |
133-
134130
### Return Value
135131

136132
### Code Example
137133

138134
```java showLineNumbers
139-
OpenIMClient.getInstance().userInfoManager.getUsersInfoWithCache(new OnBase<List<UserInfo>>() {
140-
@Override
141-
public void onError(int code, String error) {
142-
143-
}
144-
145-
@Override
146-
public void onSuccess(List<UserInfo> data) {
147-
148-
}
149-
},uidList,groupId);
135+
OpenIMClient.getInstance().userInfoManager.getUsersInfo(new OnBase<List<PublicUserInfo>>() {
136+
@Override
137+
public void onError(int code, String error) {
138+
// todo: request error
139+
}
140+
@Override
141+
public void onSuccess(List<PublicUserInfo> data) {
142+
// todo: request success
143+
}
144+
},uidList);
150145

151146
```
152147

0 commit comments

Comments
 (0)