deleteFriend

Description

info

Delete a friend.

Note

(1) Because it is a two-way friendship, this function only removes the other party from your own friend list;
(2) Deleting a friend will not automatically delete the conversation. To delete the conversation, you can call the function to delete the conversation.

Related callbacks:
onFriendDeleted

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	User ID

Return Result

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

Code Example

   await OpenIM.iMManager.friendshipManager.deleteFriend(userID: 'userID');
    // todo

Android

Function Prototype

- (void)deleteFriend:(NSString *)friendUserID
           onSuccess:(nullable OIMSuccessCallback)onSuccess
           onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
friendUserID	NSString	Yes	User ID

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

 public void deleteFriend(OnBase<String> callBack, String uid)

Input Parameters

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

Return Result

Code Example

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

uni-app

Function Prototype

IMSDK.deleteFriend(userID: string, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	string	Yes	User ID

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

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('deleteFriend', operationID: string, userID: 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
userID	string	Yes	User ID

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('deleteFriend', IMSDK.uuid(), 'userID')
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.deleteFriend(userID: string, operationID?: string): Promise<void>;

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	string	Yes	User ID
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.deleteFriend('userID')
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void DeleteFriend(OnBase<bool> cb, string friendUserId)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback interface
friendUserId	string	Yes	User ID

Return Result

Code Example

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

},"userId");