浏览 SDKs · Android
平台
SDKsAndroid

获取黑名单列表

获取当前登录账号的完整黑名单列表。

复制

获取当前登录账号主动拉黑的完整用户列表,常用于隐私设置中的黑名单管理页或在个人主页展示“已拉黑”状态。

OpenIMClient.getInstance().friendshipManager.getBlacklist(
    new OnBase<List<UserInfo>>() {
        @Override
        public void onSuccess(List<UserInfo> users) {
            // 使用 users 更新黑名单列表
        }

        @Override
        public void onError(int code, String error) {
            // 处理错误
        }
    }
);

参数说明

参数类型是否必填说明
baseOnBase<List<UserInfo>>是异步请求回调。

返回结果

成功回调返回 List<UserInfo> 黑名单用户列表。若当前账号未拉黑任何人,返回空列表。客户端应以 userID 为主键进行去重与本地缓存更新。

通过 UserInfo 中的 blackInfo 属性可获取该条关系的 BlacklistInfo 详情:

字段说明
userID被当前用户拉黑的目标用户 ID。
nickname目标用户的昵称。
faceURL目标用户的头像 URL 地址。
gender目标用户的性别。
operatorUserID执行拉黑操作的用户 ID。
createTime加入黑名单的时间戳。
addSource黑名单关系来源途径。
ex黑名单关系扩展字段。

黑名单新增或移出时,SDK 会通过 OnFriendshipListener 派发事件,详细监听配置与处理请参考拉黑用户和取消拉黑用户。