浏览 SDKs · Android
SDKsAndroid

获取黑名单列表

使用 getBlacklist() 获取当前用户的黑名单。

复制

黑名单记录当前用户主动拉黑的用户,可用于黑名单设置页、资料卡中的关系状态和聊天入口限制。

获取黑名单

完成 SDK 初始化并登录后,调用 getBlacklist() 获取当前账号的完整黑名单。返回空列表表示当前没有黑名单用户。

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

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

成功 callback 返回 List<UserInfo>;通过 UserInfo.getBlackInfo() 读取黑名单关系对象。

黑名单记录字段

BlacklistInfo 的常用字段如下:

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

如果页面还要展示好友备注或最新公开资料,可额外查询好友资料或公开资料。

黑名单新增或删除时,可通过拉黑用户取消拉黑用户页面中的 listener 接收通知。