acceptFriendApplication

Description

info

Agree to the other party's friend request, establishing a two-way friendship.

Note

Related callbacks:
onFriendApplicationAccepted
onFriendAdded

iOS

Function Prototype

  Future<dynamic> acceptFriendApplication({
    required String userID,
    String? handleMsg,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	Applicant User ID
handleMsg	String	No	Message

Return Result

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

Code Example

    await OpenIM.iMManager.friendshipManager.acceptFriendApplication(
      userID: 'userID',
      handleMsg: 'ok, i agree',
    );
    // todo

Android

Function Prototype

- (void)acceptFriendApplication:(NSString *)userID
                      handleMsg:(NSString *)msg
              onSuccess:(nullable OIMSuccessCallback)onSuccess
              onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	NSString	Yes	Applicant User ID
msg	NSString	Yes	Message

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

public void acceptFriendApplication(OnBase<String> callBack, String uid, String msg)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase	Yes	Callback interface
uid	String	Yes	User ID
msg	String	Yes	Message

Return Result

Code Example

OpenIMClient.getInstance().friendshipManager.acceptFriendApplication(new OnBase<String>(){...},uid,msg)

uni-app

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
toUserID	string	Yes	Applicant User ID
handleMsg	string	Yes	Operation 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.acceptFriendApplication({
  toUserID: '',
  handleMsg: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('acceptFriendApplication', operationID: string, {
    toUserID: string;
    handleMsg: 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	Applicant User ID
handleMsg	string	Yes	Operation 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('acceptFriendApplication', IMSDK.uuid(), {
  toUserID: '',
  handleMsg: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
toUserID	string	Yes	Applicant User ID
handleMsg	string	Yes	Operation 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.acceptFriendApplication({
  toUserID: '',
  handleMsg: '',
})
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void AcceptFriendApplication(OnBase<bool> cb, ProcessFriendApplicationParams userIdHandleMsg)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback
userIdHandleMsg	ProcessFriendApplicationParams	Yes	Add friend parameters

Return Result

Code Example

IMSDK.AcceptFriendApplication((suc,errCode,errMsg)=>{
},new ProcessFriendApplicationParams(){
    ToUserID = "userid",
    HandleMsg = "",
});