Skip to content

Commit c1ff36d

Browse files
committed
fix: updateFriends
1 parent 0d76fd8 commit c1ff36d

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

docs/sdks/api/relation/setFriendRemark.mdx renamed to docs/sdks/api/relation/updateFriends.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ toc_min_heading_level: 2
44
toc_max_heading_level: 2
55
---
66

7-
# setFriendRemark
7+
# updateFriends
88

99
## 功能介绍
1010

1111
:::info 说明
1212

13-
修改好友备注,为空时会删除备注
13+
修改好友信息,包括置顶,备注,ex字段
1414

1515
:::
1616

@@ -40,7 +40,7 @@ values={[
4040
### 函数原型
4141

4242
```dart showLineNumbers
43-
Future<dynamic> setFriendRemark({
43+
Future<dynamic> updateFriends({
4444
required String userID,
4545
required String remark,
4646
String? operationID,
@@ -63,7 +63,7 @@ values={[
6363
### 代码示例
6464

6565
```dart showLineNumbers
66-
await OpenIM.iMManager.friendshipManager.setFriendRemark(
66+
await OpenIM.iMManager.friendshipManager.updateFriends(
6767
userID: '1129',
6868
remark: 'Tom',
6969
);
@@ -78,7 +78,7 @@ values={[
7878

7979
```swift showLineNumbers
8080

81-
- (void)setFriendRemark:(NSString *)userID
81+
- (void)updateFriends:(NSString *)userID
8282
remark:(NSString * _Nullable)remark
8383
onSuccess:(nullable OIMSuccessCallback)onSuccess
8484
onFailure:(nullable OIMFailureCallback)onFailure;
@@ -103,7 +103,7 @@ values={[
103103

104104
```swift showLineNumbers
105105

106-
[OIMManager.manager setFriendRemark:@""
106+
[OIMManager.manager updateFriends:@""
107107
remark:@""
108108
onSuccess:^(NSString * _Nullable data) {
109109
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
@@ -119,7 +119,7 @@ values={[
119119

120120
```java showLineNumbers
121121

122-
public void setFriendRemark(OnBase<String> callBack, String uid, String remark)
122+
public void updateFriends(OnBase<String> callBack, String uid, String remark)
123123

124124
```
125125

@@ -137,7 +137,7 @@ values={[
137137

138138
```java showLineNumbers
139139

140-
OpenIMClient.getInstance().friendshipManager.setFriendRemark(new OnBase<String>(){…},uid,remark)
140+
OpenIMClient.getInstance().friendshipManager.updateFriends(new OnBase<String>(){…},uid,remark)
141141

142142
```
143143

@@ -148,7 +148,7 @@ OpenIMClient.getInstance().friendshipManager.setFriendRemark(new OnBase<String>(
148148
### 函数原型
149149

150150
```ts showLineNumbers
151-
IMSDK.setFriendRemark({
151+
IMSDK.updateFriends({
152152
toUserID: string;
153153
remark: string;
154154
}, operationID?: string): Promise<WsResponse>
@@ -182,7 +182,7 @@ const IMSDK = getSDK();
182182
// import { OpenIMSDK } from 'open-im-sdk';
183183
// const IMSDK = new OpenIMSDK();
184184

185-
IMSDK.setFriendRemark({
185+
IMSDK.updateFriends({
186186
toUserID: '',
187187
remark: '',
188188
})
@@ -201,7 +201,7 @@ IMSDK.setFriendRemark({
201201
### 函数原型
202202

203203
```ts showLineNumbers
204-
IMSDK.asyncApi('setFriendRemark', operationID: string, {
204+
IMSDK.asyncApi('updateFriends', operationID: string, {
205205
toUserID: string;
206206
remark: string;
207207
}): Promise<void>
@@ -229,7 +229,7 @@ IMSDK.asyncApi('setFriendRemark', operationID: string, {
229229
```js showLineNumbers
230230
import IMSDK from 'openim-uniapp-polyfill';
231231

232-
IMSDK.asyncApi('setFriendRemark', IMSDK.uuid(), {
232+
IMSDK.asyncApi('updateFriends', IMSDK.uuid(), {
233233
toUserID: '',
234234
remark: '',
235235
})
@@ -247,7 +247,7 @@ IMSDK.asyncApi('setFriendRemark', IMSDK.uuid(), {
247247
### 函数原型
248248

249249
```ts showLineNumbers
250-
OpenIMSDKRN.setFriendRemark({
250+
OpenIMSDKRN.updateFriends({
251251
toUserID: string;
252252
remark: string;
253253
}, operationID: string): Promise<void>
@@ -273,7 +273,7 @@ OpenIMSDKRN.setFriendRemark({
273273
```js showLineNumbers
274274
import OpenIMSDKRN from "open-im-sdk-rn";
275275

276-
OpenIMSDKRN.setFriendRemark({
276+
OpenIMSDKRN.updateFriends({
277277
toUserID: '',
278278
remark: '',
279279
}, 'operationID')
@@ -293,7 +293,7 @@ OpenIMSDKRN.setFriendRemark({
293293

294294
```C# showLineNumbers
295295

296-
public static void SetFriendRemark(OnSucOrError cb, SetFriendRemarkParams userIDRemark)
296+
public static void UpdateFriends(OnSucOrError cb, UpdateFriendsParams userIDRemark)
297297

298298
```
299299

@@ -302,17 +302,17 @@ public static void SetFriendRemark(OnSucOrError cb, SetFriendRemarkParams userID
302302
| 参数名称 | 参数类型 | 是否必填 | 描述 |
303303
| -------- | --------------------------------------- | -------- | -------- |
304304
| cb | [OnSucOrError](docs/sdks/callback/OnSucOrError.mdx) || 回调接口 |
305-
| userIDRemark |[SetFriendRemarkParams](docs/sdks/class/relation/SetFriendRemarkParams.mdx) || 设置参数 |
305+
| userIDRemark |[UpdateFriendsParams](docs/sdks/class/relation/UpdateFriendsParams.mdx) || 设置参数 |
306306

307307
### 返回结果
308308

309309
### 代码示例
310310

311311
```C# showLineNumbers
312312

313-
IMSDK.SetFriendRemark((suc,errCode,errMsg)=>{
313+
IMSDK.UpdateFriends((suc,errCode,errMsg)=>{
314314

315-
},new SetFriendRemarkParams(){
315+
},new UpdateFriendsParams(){
316316
ToUserID = "userid",
317317
Remark = "",
318318
})

0 commit comments

Comments
 (0)