getBlackList
功能介绍
说明
获取黑名单列表。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<List<BlacklistInfo>> getBlackList({String? operationID})
输入参数
无
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | List<BlacklistInfo> | 成功返回 |
代码示例
List<BlacklistInfo> list = await OpenIM.iMManager.friendshipManager.getBlackList();
// todo
函数原型
- (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) {
}];
函数原型
public void getBlackList(OnBase<List<UserInfo>> callBack)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase<List<UserInfo>> | 是 | 回调接口 |
返回结果
代码示例
OpenIMClient.getInstance().friendshipManager.getBlackList(new OnBase<List<UserInfo>>(){...})
函数原型
IMSDK.getBlackList(operationID?: string): Promise<WsResponse<BlackUserItem[]>>
输入参数
无
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<BlackUserItem[]>> | 黑名单信息对象列表 |
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 { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.getBlackList()
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
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 }) => {
// 调用失败
});
函数原型
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 }) => {
// 调用失败
});