黑名单管理

将用户加入黑名单之后，将不再收到对方发来的任何单聊消息。

• 加入黑名单为单向操作，例如：用户 A 拉黑用户 B，代表 B 无法给 A 发消息（错误码 405）。但 A 向 B 发消息，B 仍然能正常接收。
• 单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。
• 调用服务端 API 发送单聊消息默认不受黑名单限制。如需启用限制，请在调用 API 时设置 verifyBlacklist 为 1。

加入黑名单

将某个用户加入黑名单。

方法

addToBlacklist(userId: string): Promise<number>;

参数说明

参数	类型	说明
userId	string	用户 ID

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法

• setOnBlacklistAddedListener

setOnBlacklistAddedListener(listener?: (code: number, userId: string) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
userId	String	用户 ID

代码示例

setOnBlacklistAddedListener(
  (
    code: number,
    userId: string
  ) => {}
);

移除黑名单

将某个用户从黑名单中移出。

方法

removeFromBlacklist(userId: string): Promise<number>;

参数说明

参数	类型	说明
userId	string	用户 ID

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法

• setOnBlacklistRemovedListener

setOnBlacklistRemovedListener(listener?: (code: number, userId: string) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
userId	string	用户 ID

代码示例

engine.setOnBlacklistRemovedListener(
  (
    code: number,
    userId: string
  ) => {}
);

查询用户是否在黑名单中

获取某用户是否在黑名单中。

方法

loadBlacklistStatus(userId: string): Promise<number>;

参数说明

参数	类型	说明
userId	String	用户 ID

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法

• setOnBlacklistStatusLoadedListener

setOnBlacklistStatusLoadedListener(listener?: (code: number, userId: string, status: RCIMIWBlacklistStatus) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
userId	string	用户 ID
status	RCIMIWBlacklistStatus	当前状态

代码示例

main.engine?.setOnBlacklistStatusLoadedListener(
  (
    code: number,
    userId: string,
    status: RCIMIWBlacklistStatus
  ) => {}
);

获取黑名单列表

获取当前用户设置的黑名单列表。

方法

loadBlacklist(): Promise<number>;

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

回调方法

• onBlacklistLoaded

setOnBlacklistLoadedListener(listener?: (code: number, userIds: Array<string>) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
userIds	Array<String>	用户 ID 集合

代码示例

engine.setOnBlacklistLoadedListener(
  (
    code: number,
    userIds: Array<string>
  ) => {}
);