setFriendRemark

功能介绍

说明

修改好友备注，为空时会删除备注。

注意

相关回调:
onFriendInfoChanged
onConversationChanged

iOS

函数原型

 Future<dynamic> setFriendRemark({
    required String userID,
    required String remark,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
userID	String	是	用户 ID
remark	String	否	要设置的备注，为空字符串时会取消备注

返回结果

参数名称	参数类型	描述
~	~	无异常抛出则修改成功

代码示例

     await OpenIM.iMManager.friendshipManager.setFriendRemark(
       userID: '1129',
       remark: 'Tom',
    );
    // todo

Android

函数原型

- (void)setFriendRemark:(NSString *)userID
                 remark:(NSString * _Nullable)remark
              onSuccess:(nullable OIMSuccessCallback)onSuccess
              onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
userID	NSString	是	用户 ID
remark	NSString	否	要设置的备注，为空字符串时会取消备注

返回结果

参数名称	参数类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager setFriendRemark:@""
                             remark:@""
                          onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

  public void setFriendRemark(OnBase<String> callBack, String uid, String remark)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase	是	回调接口
uid	String	是	用户 ID
remark	String	是	备注

返回结果

代码示例

OpenIMClient.getInstance().friendshipManager.setFriendRemark(new OnBase<String>(){…},uid,remark)

uni-app

函数原型

IMSDK.setFriendRemark({
    toUserID: string;
    remark: string;
}, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
toUserID	string	是	好友用户 ID
remark	string	是	要设置的备注，为空字符串时会取消备注

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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.setFriendRemark({
  toUserID: '',
  remark: '',
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('setFriendRemark', operationID: string, {
    toUserID: string;
    remark: string;
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
toUserID	string	是	好友用户 ID
remark	string	是	要设置的备注，为空字符串时会取消备注

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setFriendRemark', IMSDK.uuid(), {
  toUserID: '',
  remark: '',
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.setFriendRemark({
  toUserID: string;
  remark: string;
}, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
toUserID	string	是	好友用户 ID
remark	string	是	要设置的备注，为空字符串时会取消备注
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.setFriendRemark({
  toUserID: '',
  remark: '',
}, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SetFriendRemark(OnSucOrError cb, SetFriendRemarkParams userIDRemark)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnSucOrError	是	回调接口
userIDRemark	SetFriendRemarkParams	是	设置参数

返回结果

代码示例

IMSDK.SetFriendRemark((suc,errCode,errMsg)=>{

},new SetFriendRemarkParams(){
    ToUserID = "userid",
    Remark = "",
})