updateFriends
功能介绍
说明
修改好友信息,包括置顶,备注,ex 字段。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
### 函数原型
Future updateFriends(
UpdateFriendsReq req, {
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
updateFriendsReq | UpdateFriendsReq | 是 | 变更的结构体 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
await OpenIM.iMManager.conversationManager.updateFriends(req);
//todo
函数原型
- (void)updateFriends:(OIMUpdateFriendsReq *)req
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
req | UpdateFriendsReq | 是 | 变更的结构体 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager updateFriends:req
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
public void updateFriendsReq(OnBase<String> base, UpdateFriendsReq updateFriendsReq)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
updateFriendsReq | UpdateFriendsReq | 是 | 变更的结构体 |
返回结果
代码示例
OpenIMClient.getInstance().friendshipManager.updateFriendsReq(new OnBase<String>() {
@Override
public void onError(int code, String error) {
// todo: 处理错误信息
}
@Override
public void onSuccess(String data) {
// todo: 请求成功
}
}, updateFriendsReq);
函数原型
IMSDK.updateFriends({
friendUserIDs: string[];
isPinned?: boolean;
remark?: boolean;
ex?: boolean;
},operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
friendUserIDs | string[] | 是 | 好友 ID 列表 |
isPinned | boolean | 否 | 是否为星标好友 |
remark | string | 否 | 好友备注 |
ex | string | 否 | ex 字段 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.updateFriends({
friendUserIDs: ['userID'],
remark: "new remark"
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('updateFriends', operationID: string, {
friendUserIDs: string[];
isPinned?: boolean;
remark?: boolean;
ex?: boolean;
}): Promise<FullUserItem[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
friendUserIDs | string[] | 是 | 好友 ID 列表 |
isPinned | boolean | 否 | 是否为星标好友 |
remark | string | 否 | 好友备注 |
ex | string | 否 | ex 字段 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('updateFriends', IMSDK.uuid(), {
friendUserIDs: ['userID'],
remark: "new remark"
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.updateFriends({
friendUserIDs: string[];
isPinned?: boolean;
remark?: boolean;
ex?: boolean;
}, operationID: string): Promise<FullUserItem[]>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
friendUserIDs | string[] | 是 | 好友 ID 列表 |
isPinned | boolean | 否 | 是否为星标好友 |
remark | string | 否 | 好友备注 |
ex | string | 否 | ex 字段 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from 'open-im-sdk-rn';
OpenIMSDKRN.updateFriends({
friendUserIDs: ['userID'],
remark: "new remark"
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
public static void UpdateFriends(OnBase<bool> cb, UpdateFriendsReq req);
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
cb | OnBase | 是 | 回调 |
updateFriendsReq | UpdateFriendsReq | 是 | 变更的结构体 |
返回结果
代码示例
IMSDK.UpdateFriends((suc,errCode,errMsg)=>{
}
, updateFriendsReq);