addFriend

Description

info

Initiate a friend request to add the other party as a friend.

Note

Related callbacks:
onFriendApplicationAdded

iOS

Function Prototype

  Future<dynamic> addFriend({
    required String userID,
    String? reason,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	User ID to add
reason	String	Yes	Request message

Return Result

Parameter Name	Parameter Type	Description
~	~	Added successfully if no exception is thrown

Code Example

    await OpenIM.iMManager.friendshipManager.addFriend(userID: 'userID',reason: 'i want to');
    // todo

Android

Function Prototype

- (void)addFriend:(NSString *)userID
       reqMessage:(NSString * _Nullable)reqMessage
        onSuccess:(nullable OIMSuccessCallback)onSuccess
        onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	NSString	Yes	User ID to add
reqMessage	NSString	Yes	Request message

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

public void addFriend(OnBase<String> callBack, String uid,String reqMessage)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase	Yes	Callback interface
uid	String	Yes	User ID
reqMessage	String	Yes	The message the other party sees when requesting to add as a friend

Return Result

Code Example

OpenIMClient.getInstance().friendshipManager.addFriend(new OnBase<String>(){...},uid,reqMessage)

uni-app

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
toUserID	string	Yes	User ID to add
reqMsg	string	Yes	Friend request message

Return Result

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

Code Example

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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.addFriend({
  toUserID: '',
  reqMsg: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
toUserID	string	Yes	User ID to add
reqMsg	string	Yes	Friend request message

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to 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>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

Function Prototype

OpenIMSDK.addFriend({
  toUserID: string;
  reqMsg: string;
}, operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
toUserID	string	Yes	User ID to add
reqMsg	string	Yes	Friend request message
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.addFriend({
  toUserID: '',
  reqMsg: '',
})
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void AddFriend(OnBase<bool> cb, ApplyToAddFriendReq userIdReqMsg)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback
userIdReqMsg	ApplyToAddFriendReq	Yes	Add friend parameters

Return Result

Code Example

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

},new ApplyToAddFriendReq(){
    FromUserID = "",
    ToUserID = "",
    ReqMsg = "",
    Ex = "",
});