Skip to content

Commit de7c526

Browse files
JauneQJauneQ
committed
docs: update docs about android
1 parent 54b089f commit de7c526

10 files changed

Lines changed: 147 additions & 91 deletions

File tree

‎docs/sdks/api/conversation/setConversation.mdx‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,35 @@ Future setConversation(
114114

115115
<TabItem value="Android">
116116

117-
:::info 说明
117+
### 函数原型
118118

119-
待更新
119+
```java showLineNumbers
120+
public void setConversation(OnBase<String> base, String conversationID, ConversationReq conversationReq)
121+
```
120122

121-
:::
123+
### 输入参数
124+
125+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
126+
| -------------- | -------- | -------- | ------- |
127+
| conversationID | String | 是 | 会话 ID |
128+
| conversationReq | [ConversationReq](docs/sdks/class/conversation/conversationReq.mdx) | 是 | 变更的结构体 |
129+
130+
### 返回结果
131+
132+
### 代码示例
133+
134+
```java showLineNumbers
135+
OpenIMClient.getInstance().conversationManager.setConversation(new OnBase<String>() {
136+
@Override
137+
public void onError(int code, String error) {
138+
// todo: 处理错误信息
139+
}
140+
@Override
141+
public void onSuccess(String data) {
142+
// todo: 请求成功
143+
}
144+
}, conversationID , conversationReq);
145+
```
122146

123147
</TabItem>
124148

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

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -115,32 +115,30 @@ param.introduction = @"";
115115
### 函数原型
116116

117117
```java showLineNumbers
118-
public void setGroupInfo(GroupInfo groupInfo, OnBase<String> callBack)
118+
public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase<String> callBack)
119119
```
120120

121121
### 输入参数
122122

123-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
124-
| ------------ | --------------------------------------- | -------- | -------- |
125-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
126-
| groupInfo | [GroupInfo](docs/sdks/class/group/groupInfo.mdx) | 是 | 群 信息 |
123+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
124+
| ---------------- | --------------------------------------------------------------- | -------- | -------- |
125+
| groupMembersInfo | [SetGroupMemberInfo](docs/sdks/class/group/SetGroupMemberInfo.mdx) | 是 | 成员信息 |
127126

128127
### 返回结果
129128

130129
### 代码示例
131130

132131
```java showLineNumbers
133-
OpenIMClient.getInstance().groupManager.setGroupInfo(groupInfo,new OnBase<String>() {
134-
@Override
135-
public void onError(int code, String error) {
132+
OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo,new OnBase<String>() {
133+
@Override
134+
public void onError(int code, String error) {
136135

137-
}
136+
}
137+
@Override
138+
public void onSuccess(String data) {
138139

139-
@Override
140-
public void onSuccess(String data) {
141-
142-
}
143-
});
140+
}
141+
});
144142
```
145143

146144
</TabItem>

‎docs/sdks/api/relation/getFriendList.mdx‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -99,16 +99,14 @@ onSuccess:^(NSArray<PublicUserInfo *> * _Nullable userInfos) {
9999
### 函数原型
100100

101101
```java showLineNumbers
102-
103-
public void getFriendList(OnBase<List<UserInfo>> callBack)
104-
102+
public void getFriendListByFilterBlack(OnBase<List<UserInfo>> base, Boolean filterBlack)
105103
```
106104

107105
### 输入参数
108106

109-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
110-
| -------- | -------------------------------------------------------------------------------------------- | -------- | -------- |
111-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)\<List\<[UserInfo](docs/sdks/class/user/userInfo.mdx)>> | 是 | 回调接口 |
107+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
108+
| -------- | -------- | -------- | ------- |
109+
| filterBlack | Boolean | 否 | 是否过滤掉黑名单 |
112110

113111
### 返回结果
114112

@@ -119,19 +117,16 @@ onSuccess:^(NSArray<PublicUserInfo *> * _Nullable userInfos) {
119117
### 代码示例
120118

121119
```java showLineNumbers
122-
123-
OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>(){
120+
OpenIMClient.getInstance().friendshipManager.getFriendListByFilterBlack(new OnBase<List<UserInfo>>() {
124121
@Override
125122
public void onError(int code, String error) {
126-
123+
// todo: 处理错误信息
127124
}
128-
129125
@Override
130126
public void onSuccess(List<UserInfo> data) {
131-
127+
// todo: 请求成功，返回List<UserInfo>
132128
}
133-
})
134-
129+
}, filterBlack);
135130
```
136131

137132
</TabItem>

‎docs/sdks/api/relation/getFriendListPage.mdx‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,16 @@ onSuccess:^(NSArray<PublicUserInfo *> * _Nullable userInfos) {
115115
### 函数原型
116116

117117
```java showLineNumbers
118-
119-
public void getFriendList(OnBase<List<UserInfo>> callBack)
120-
118+
public void getFriendListPageByFilterBlack(OnBase<List<UserInfo>> base, int offset, int count, Boolean filterBlack)
121119
```
122120

123121
### 输入参数
124122

125-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
126-
| -------- | -------------------------------------------------------------------------------------------- | -------- | -------- |
127-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[UserInfo](docs/sdks/class/user/userInfo.mdx)>> | 是 | 回调接口 |
123+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
124+
| -------- | -------- | -------- | ------- |
125+
| offset | int | 是 | 分页拉取起始下标 |
126+
| count | int | 是 | 一页拉取的数量 |
127+
| filterBlack | Boolean | 否 | 是否过滤掉黑名单 |
128128

129129
### 返回结果
130130

@@ -134,20 +134,18 @@ onSuccess:^(NSArray<PublicUserInfo *> * _Nullable userInfos) {
134134

135135
### 代码示例
136136

137-
```java showLineNumbers
138137

139-
OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>(){
138+
```java showLineNumbers
139+
OpenIMClient.getInstance().friendshipManager.getFriendListPageByFilterBlack(new OnBase<List<UserInfo>>() {
140140
@Override
141141
public void onError(int code, String error) {
142-
142+
// todo: 处理错误信息
143143
}
144-
145144
@Override
146145
public void onSuccess(List<UserInfo> data) {
147-
146+
// todo: 请求成功，返回List<UserInfo>
148147
}
149-
})
150-
148+
}, filterBlack);
151149
```
152150

153151
</TabItem>

‎docs/sdks/api/relation/getSpecifiedFriendsInfo.mdx‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -107,31 +107,30 @@ values={[
107107
### 函数原型
108108

109109
```java showLineNumbers
110-
public void getFriendsInfo(OnBase<List<UserInfo>> base, List<String> uidList)
110+
public void getFriendsInfoByFilterBlack(OnBase<List<UserInfo>> base, List<String> uidList, Boolean filterBlack)
111111
```
112112

113113
### 输入参数
114114

115-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
116-
| -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ |
117-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[UserInfo](docs/sdks/class/user/userInfo.mdx)>> | 是 | 回调接口 |
118-
| uidList | List<String\> | 是 | 用户 ID 集合 |
115+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
116+
| ---------- | ------------- | -------- | ------------ |
117+
| userIDList | List\<String\> | 是 | 用户 ID 列表 |
118+
| filterBlack | Boolean | 否 | 是否过滤掉黑名单 |
119119

120120

121121
### 代码示例
122122

123123
```java showLineNumbers
124-
OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase<List<UserInfo>>() {
125-
@Override
126-
public void onError(int code, String error) {
127-
128-
}
129-
130-
@Override
131-
public void onSuccess(List<UserInfo> data) {
132-
133-
}
134-
},uidList);
124+
OpenIMClient.getInstance().friendshipManager.getFriendsInfoByFilterBlack(new OnBase<List<UserInfo>>() {
125+
@Override
126+
public void onError(int code, String error) {
127+
// todo: 处理错误信息
128+
}
129+
@Override
130+
public void onSuccess(List<UserInfo> data) {
131+
// todo: 请求成功，返回List<UserInfo>
132+
}
133+
}, uidList, filterBlack);
135134
```
136135
</TabItem>
137136

‎docs/sdks/api/relation/updateFriends.mdx‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,32 @@ Future updateFriends(
109109

110110
<TabItem value="Android">
111111

112-
:::info 说明
112+
```java showLineNumbers
113+
public void updateFriendsReq(OnBase<String> base, UpdateFriendsReq updateFriendsReq)
114+
```
113115

114-
待更新
116+
### 输入参数
115117

116-
:::
118+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
119+
| -------------- | -------- | -------- | ------- |
120+
| updateFriendsReq | [UpdateFriendsReq](docs/sdks/class/relation/updateFriendsReq.mdx) | 是 | 变更的结构体 |
121+
122+
### 返回结果
123+
124+
### 代码示例
125+
126+
```java showLineNumbers
127+
OpenIMClient.getInstance().friendshipManager.updateFriendsReq(new OnBase<String>() {
128+
@Override
129+
public void onError(int code, String error) {
130+
// todo: 处理错误信息
131+
}
132+
@Override
133+
public void onSuccess(String data) {
134+
// todo: 请求成功
135+
}
136+
}, updateFriendsReq);
137+
```
117138

118139
</TabItem>
119140

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

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -112,35 +112,31 @@ await OpenIM.iMManager.userManager.getUsersInfoWithCache([], '');
112112
### 函数原型
113113

114114
```java showLineNumbers
115-
116-
public void getUsersInfoWithCache(OnBase<List<UserInfo>> callBack, List<String> uidList,String groupID)
117-
115+
public void getUsersInfo(OnBase<List<PublicUserInfo>> callBack, List<String> uidList)
118116
```
119117

120118
### 输入参数
121119

122120
| 参数名称 | 参数类型 | 是否必填 | 描述 |
123121
| -------- | -------------------------------------------------------------------------------------------- | -------- | ------------ |
124-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[UserInfo](docs/sdks/class/user/userInfo.mdx)>> | 是 | 回调接口 |
122+
| callBack | [OnBase](docs/sdks/callback/onBase.mdx)<List<[PublicUserInfo](docs/sdks/class/user/publicInfo.mdx)>> | 是 | 回调接口 |
125123
| uidList | List<String\> | 是 | 用户 ID 集合 |
126124
| groupID | String | false | 群ID |
127125
### 返回结果
128126

129127
### 代码示例
130128

131129
```java showLineNumbers
132-
OpenIMClient.getInstance().userInfoManager.getUsersInfoWithCache(new OnBase<List<UserInfo>>() {
133-
@Override
134-
public void onError(int code, String error) {
135-
136-
}
137-
138-
@Override
139-
public void onSuccess(List<UserInfo> data) {
140-
141-
}
142-
},uidList,groupId);
143-
130+
OpenIMClient.getInstance().userInfoManager.getUsersInfo(new OnBase<List<PublicUserInfo>>() {
131+
@Override
132+
public void onError(int code, String error) {
133+
// todo: 处理错误信息
134+
}
135+
@Override
136+
public void onSuccess(List<PublicUserInfo> data) {
137+
// todo: 请求成功，返回PublicUser
138+
}
139+
},uidList);
144140
```
145141

146142
</TabItem>

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

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -125,29 +125,37 @@ info.faceURL = @"";
125125
### 函数原型
126126

127127
```java showLineNumbers
128-
129-
public void setSelfInfo(OnBase<String> callBack, String nickname, String faceURL, int appMangerLevel, String ex)
130-
128+
public void setSelfInfo(OnBase<String> base, UserInfoReq userInfoReq)
131129
```
132130

133131
### 输入参数
134132

135-
| 参数名称 | 参数类型 | 是否必填 | 描述 |
136-
| -------------- | --------------------------------------- | -------- | ------------------------------ |
137-
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
138-
| nickname | String | 是 | 名字 |
139-
| faceURL | String | 是 | 用户头像URL |
140-
| gender | int | 是 | 性别 1：男 2：女 |
141-
| appMangerLevel | int | 是 | 内部字段，可忽略 |
142-
| ex | String | 否 | 扩展字段 |
133+
请求结构体UserInfoReq属性如下所示：
134+
135+
| 参数名称 | 参数类型 | 是否必填 | 描述 |
136+
| -------------- | -------- | -------- | -------------- |
137+
| userID | String | 是 | 用户id |
138+
| nickname | String | 否 | 用户昵称 |
139+
| faceURL | String | 否 | 用户头像 |
140+
| ex | String | 否 | 扩展参数 |
141+
| globalRecvMsgOpt | Integer | 否 | 全局免打扰，1:屏蔽消息; 2:接收消息但不提示; 0:正常 |
143142

144143
### 返回结果
145144

146145
### 代码示例
147146

148147
```java showLineNumbers
149148

150-
OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase<String>(){…},...);
149+
OpenIMClient.getInstance().userInfoManager.setSelfInfo(new OnBase<String>(){
150+
@Override
151+
public void onError(int code, String error) {
152+
// todo: 处理错误信息
153+
}
154+
@Override
155+
public void onSuccess(String data) {
156+
// todo: 请求成功
157+
}
158+
},userInfoReq);
151159

152160
```
153161

‎docs/sdks/class/conversation/conversationReq.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ values={[
6161

6262
### ConversationReq
6363

64+
| 字段名称 | 字段类型 | 描述 |
65+
| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- |
66+
| recvMsgOpt | [int](docs/sdks/enum/recvMsgOpt.mdx) | 接收消息 免打扰 0：正常；1：不接受消息；2：接受在线消息不接受离线消息 |
67+
| groupAtType | [int](docs/sdks/enum/groupAtType.mdx) | @类型 |
68+
| isPinned | boolean | 是否置顶 |
69+
| isPrivateChat | boolean | 是否开启了阅后即焚 |
70+
| burnDuration | int | 阅后即焚时间（秒） |
71+
| ex | String | 扩展字段 |
72+
6473
</TabItem>
6574

6675
<TabItem value="Web">

‎docs/sdks/class/relation/updateFriendsReq.mdx‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,15 @@ values={[
5555

5656
<TabItem value="Android">
5757

58-
### ConversationReq
58+
### UpdateFriendsReq
59+
60+
| 字段名称 | 字段类型 | 描述 |
61+
| ----------------- | -------------------------------------------------- | --------------------------------------------------------------------- |
62+
| remark | String | 备注 |
63+
| isPinned | Boolean | 是否置顶 |
64+
| friendUserIDs | String[] | 好友的User ID列表 |
65+
| ex | String | 扩展字段 |
66+
5967

6068
</TabItem>
6169

0 commit comments

Comments
 (0)