setFriendRemark

Feature Introduction

Note

Modify a friend's remark.

Attention

Related callbacks: onFriendInfoChanged onConversationChanged

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
userID	String	Yes	User ID
remark	String	No	Remark to set. If empty, the remark will be removed.

Return Result

Parameter Name	Parameter Type	Description
~	~	No exception means modification was successful.

Code Example

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

Android

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
userID	NSString	Yes	User ID
remark	NSString	No	Remark to set. If empty, the remark will be removed.

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Successful return.
onFailure	OIMFailureCallback	Failed return.

Code Example

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

Flutter

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
callBack	OnBase	Yes	Callback interface.
uid	String	Yes	User ID
remark	String	Yes	Remark

Return Result

Code Example

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

uni-app

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
toUserID	string	Yes	Friend's User ID
remark	string	Yes	Remark to set. If empty, the remark will be removed.

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse>	Success callback.
Promise.catch()	Promise<WsResponse>	Failed callback.

Code Example

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(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID for issue identification. Unique recommendation using current time and random number.
toUserID	string	Yes	Friend's User ID
remark	string	Yes	Remark to set. If empty, the remark will be removed.

Return Result

The function is made Promise via the openim-uniapp-polyfill package. When calling, use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback.
Promise.catch()	Promise<CatchResponse>	Failed callback.

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setFriendRemark', IMSDK.uuid(), {
  toUserID: '',
  remark: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
toUserID	string	Yes	Friend's User ID
remark	string	Yes	Remark to set. If empty, the remark will be removed.
operationID	string	Yes	Operation ID, used for problem location, keep unique, suggest using current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Callback on successful call
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

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

OpenIMSDKRN.setFriendRemark({
  toUserID: '',
  remark: '',
}, 'operationID')
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Unity

Function Prototype

public static void SetFriendRemark(OnSucOrError cb, SetFriendRemarkParams userIDRemark)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnSucOrError	Yes	Callback
userIDRemark	SetFriendRemarkParams	Yes	Remark Parameter

Return Result

Code Example

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

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