黑名单管理

说明

黑名单和好友操作互不影响。

以用户A和B互为好友为例：

用户A可以将用户B列入黑名单，但两人仍是好友。
如果此时用户A和用户B解除好友关系，用户B仍会在用户A的黑名单中。
之后，如果用户A将用户B从黑名单中移除，用户B仍不会是用户A的好友。

功能简介

用户可以查询自己的黑名单、将指定用户拉黑（不再接收该用户消息）、移出黑名单、以及检查指定用户是否在黑名单内。

实现流程

查询黑名单列表

查询结果通过 ZIMBlacklistQueriedCallback 返回。

示例代码

// 查询黑名单
ZIMBlacklistQueryConfig config = ZIMBlacklistQueryConfig();
// 填写一次获取的用户信息数量
config.count = 100;
// 填写分页拉取标志
config.nextFlag = 0;
ZIM zim = ZIM.getInstance()!;
zim.queryBlacklist(config).then((ZIMBlacklistQueriedResult result) => {
    // 开发者可以从 result.blacklist 中获取黑名单信息。
}).catchError((onError){
    // 根据 SDK 错误码文档进行处理
});

Copied!

拉黑用户

拉黑用户结果通过 ZIMBlacklistUsersAddedResult 返回。

注意

调用一次接口，最多拉黑 20 名用户。超过数量上限会导致接口调用失败。
黑名单数量上限默认为 1000，如需上调，请联系 ZEGO 技术支持。

示例代码

// 将用户 "zego" 添加到黑名单
try{
    ZIMBlacklistUsersAddedResult result = await ZIM.getInstance()!.addUsersToBlacklist(['zego']);
    // result.errorUserList 返回添加失败的用户信息。
} on PlatformException catch (onError){
    // 根据 SDK 错误码文档进行处理
}

Copied!

将用户移出黑名单

移出操作将通过 ZIMBlacklistUsersRemovedResult 返回。

注意

调用一次接口，最多移出 20 名用户。超过数量上限会导致接口调用失败。

示例代码

// 从黑名单中移除用户 "zego"
try{
    ZIMBlacklistUsersRemovedResult result = await ZIM.getInstance()!.removeUsersFromBlacklist(["zego"]);
    // result.errorUserList 返回添加失败的用户信息。
} on PlatformException catch (onError){
    // 根据 SDK 错误代码文档进行处理
}

Copied!

检查用户是否在黑名单内

检查操作结果通过 ZIMBlacklistCheckedResult 返回。

示例代码

// 检查用户 "zego" 是否在黑名单中
try{
    ZIMBlacklistCheckedResult result = await ZIM.getInstance()!.checkUserIsInBlacklist("zego");
    // result.isUserInBlacklist 表示用户是否在黑名单中。true 表示在黑名单中，false 表示不在黑名单中
} on PlatformException catch (onError){
    // 根据 SDK 错误代码文档进行处理
}

Copied!