getBlackList

功能介绍

说明

获取黑名单列表。

iOS

函数原型

 Future<List<BlacklistInfo>> getBlacklist({String? operationID})

输入参数

无

返回结果

参数名称	参数类型	描述
~	List<BlacklistInfo>	成功返回

代码示例

    List<BlacklistInfo> list = await OpenIM.iMManager.friendshipManager.getBlacklist();
    // todo

Android

函数原型

- (void)getBlackListWithOnSuccess:(nullable OIMBlacksInfoCallback)onSuccess
                         onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

无

返回结果

参数名称	参数类型	描述
onSuccess	NSArray< OIMBlackInfo * >	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager getBlackListWithOnSuccess:^(NSArray<OIMBlackInfo *> * _Nullable userInfos) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

public void getBlacklist(OnBase<List<UserInfo>> callBack)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<List<UserInfo>>	是	回调接口

返回结果

代码示例

OpenIMClient.getInstance().friendshipManager.getBlacklist(new OnBase<List<UserInfo>>(){...})

uni-app

函数原型

IMSDK.getBlacklist(operationID?: string): Promise<WsResponse<BlackUserItem[]>>

输入参数

无

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<BlackUserItem[]>>	黑名单信息对象列表
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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 { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();

IMSDK.getBlacklist()
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('getBlacklist', operationID: string): Promise<BlackUserItem[]>

输入参数

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

返回结果

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

参数名称	参数类型	描述
Promise.then()	Promise<BlackUserItem[]>	黑名单信息对象列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

OpenIMSDKRN.getBlackList(operationID: string): Promise<BlackUserItem[]>

输入参数

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

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<BlackUserItem[]>	黑名单信息对象列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

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

OpenIMSDKRN.getBlackList('operationID')
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void GetBlackList(OnLocalBlackList cb)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnLocalBlackList	是	回调接口

返回结果

代码示例

IMSDK.GetBlackList((list,errCode,errMsg)=>{

});