addBlack

功能介绍

说明

把对方添加到黑名单中。

注意

意味着对方不能给你发送消息，但你可以给对方发送消息。
相关回调:
onBlackAdded

iOS

函数原型

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

输入参数

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

返回结果

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

代码示例

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

Android

函数原型

- (void)addToBlackList:(NSString *)userID
             onSuccess:(OIMSuccessCallback)onSuccess
             onFailure:(OIMFailureCallback)onFailure;

输入参数

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

返回结果

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

代码示例

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

Flutter

### 函数原型

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

输入参数

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

返回结果

代码示例

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

uni-app

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	string	是	用户 ID
ex	string	否	扩展字段

返回结果

参数名称	参数类型	描述
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.addBlack({ toUserID: 'userID' })
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('addBlack', operationID: string, {
  toUserID: string;
  ex?: string;
}): Promise<void>

输入参数

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

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

OpenIMSDKRN.addBlack({
  toUserID: string;
  ex?: string;
}, operationID: string): Promise<void>;

输入参数

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

返回结果

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

代码示例

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

OpenIMSDKRN.addBlack({
  toUserID: 'userID',
}, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

### 函数原型

public static void AddBlack(OnBase<bool> cb, string blackUserId, string ex)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调
blackUserId	string	是	用户 ID
ex	string	是	自定义字段

返回结果

代码示例

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

},"userId","");