deleteFriend

功能介绍

说明

删除好友。

注意

（1）由于是双向好友关系，此函数仅把对方从自己的好友列表中删除；
（2）删除好友并不会自动删除会话，如要删除会话，可以再调用删除会话的函数。

相关回调:
onFriendDeleted

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	String	是	用户 ID

返回结果

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

代码示例

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

Android

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
friendUserID	NSString	是	用户 ID

返回结果

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

代码示例

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

Flutter

函数原型

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

输入参数

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

返回结果

代码示例

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

uni-app

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	string	是	用户 ID

返回结果

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

代码示例

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(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('deleteFriend', operationID: string, userID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
userID	string	是	用户 ID

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	string	是	用户 ID
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDK.deleteFriend('userID')
  .then(() => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调接口
friendUserId	string	是	用户 ID

返回结果

代码示例

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

},"userId");