浏览 SDKs · React Native
SDKsReact Native

获取黑名单

OpenIM React Native SDK 获取黑名单。

复制

调用 getBlackList() 获取当前账号的黑名单。

const blockedUsers = await OpenIMSDK.getBlackList();

返回 BlackUserItem[],常用字段如下:

字段类型说明
userIDstring被拉黑的用户 ID。
nicknamestring被拉黑用户的昵称。
faceURLstring被拉黑用户的头像地址。
ownerUserIDstring黑名单关系所属用户 ID。
operatorUserIDstring执行拉黑操作的用户 ID。
createTimenumber黑名单创建时间。
addSourcenumber黑名单添加来源。
exstring黑名单扩展字段。

资料卡或联系人列表判断黑名单关系时,应使用 userID。黑名单与群组管理是独立能力,群成员禁言或移除请使用群组相关 API。

监听黑名单变化

黑名单变化时,触发 OnBlackAddedOnBlackDeleted 事件,事件直接携带对应的黑名单用户信息:

const handleBlackAdded = (blackUser: BlackUserItem) => {
  // 按 blackUser.userID 加入或更新记录
};
const handleBlackDeleted = (blackUser: BlackUserItem) => {
  // 按 blackUser.userID 移除记录
};

OpenIMSDK.on(OpenIMEvent.OnBlackAdded, handleBlackAdded);
OpenIMSDK.on(OpenIMEvent.OnBlackDeleted, handleBlackDeleted);

OpenIMSDK.off(OpenIMEvent.OnBlackAdded, handleBlackAdded);
OpenIMSDK.off(OpenIMEvent.OnBlackDeleted, handleBlackDeleted);

退出登录、切换账号或销毁黑名单状态时,取消这些监听。