黑名单管理

说明

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

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

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

功能简介

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

实现流程

查询黑名单列表

查询结果通过 ZIMBlacklistQueriedCallback 返回。

示例代码

// 查询黑名单
ZIMBlacklistQueryConfig *config = [[ZIMBlacklistQueryConfig alloc] init];
// 每次查询的被屏蔽用户数量
config.count = 100;
// 分页拉取的标志
config.nextFlag = 0;
[[ZIM getInstance] queryBlacklistWithConfig:config callback:^(NSArray<ZIMUserInfo *> * _Nonnull blacklist, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
    if(errorInfo.code == ZIMErrorCodeSuccess){
        // 从 `blacklist` 字段获取黑名单列表
    }
}];

Copied!

拉黑用户

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

注意

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

示例代码

// 阻止用户 "zegocloud"。
NSArray *userIDs = @[@"zegocloud"];
[[ZIM getInstance] addUsersToBlacklistWithUserIDs:userIDs callback:^(NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
    if(errorInfo.code == ZIMErrorCodeSuccess){
        // 无法被阻止的用户信息将返回在 `errorUserList` 字段中。
    }
}];

Copied!

将用户移出黑名单

移出操作将通过 ZIMBlacklistUsersRemovedCallback 返回。

注意

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

示例代码

// 解除封禁用户 "zegocloud"。
NSArray *userIDs = @[@"zegocloud"];
[[ZIM getInstance] removeUsersFromBlacklistWithUserIDs:userIDs callback:^(NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo)     {
    if(errorInfo.code == ZIMErrorCodeSuccess){
        // 无法解除封禁的用户信息将返回在 `errorUserList` 字段中。
    }
}];

Copied!

检查用户是否在黑名单内

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

示例代码

// 检查用户 "zegocloud" 是否在黑名单中
[[ZIM getInstance] checkUserIsInBlackListByUserID:@"zegocloud" callback:^(BOOL isUserInBlacklist, ZIMError * _Nonnull errorInfo) {
    if(errorInfo.code == ZIMErrorCodeSuccess) {
            // `isUserInBlacklist` 参数表示用户是否在黑名单中。有效值：`true`：是；`false`：否。
    }
}];

Copied!