黑名单
黑名单用户的消息不再投递;加入/移出立即生效。
平台调用风格
进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
getBlacklist | 黑名单列表。 | REST(客户端) | [{userId:string,name?:string}] |
addToBlacklist | 加入黑名单(幂等;不能拉黑自己→1001)。 | REST(客户端) | null |
removeFromBlacklist | 移出黑名单。 | REST(客户端) | null |
本页 3 个操作,其中 3 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
getBlacklist | getBlacklist | getBlacklist | getBlacklist | getBlacklist | getBlacklist | — | func |
addToBlacklist | addToBlacklist | addToBlacklist | addToBlacklist | addToBlacklist | addToBlacklist | — | func |
removeFromBlacklist | removeFromBlacklist | removeFromBlacklist | removeFromBlacklist | removeFromBlacklist | removeFromBlacklist | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
getBlacklist
黑名单列表。
getBlacklist(): Promise<RcResult<Array<{userId: string; name?: string}>>>返回
[{userId:string,name?:string}] 成功返回的数据;失败时按错误码处理
示例
JavaScript
const res = await client.getBlacklist();
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
addToBlacklist
加入黑名单(幂等;不能拉黑自己→1001)。
addToBlacklist(userId: string): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 必填;用户 ID |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.addToBlacklist('user2'); /* code === 0 为成功 */错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
removeFromBlacklist
移出黑名单。
removeFromBlacklist(userId: string): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 必填;用户 ID |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.removeFromBlacklist('user2'); /* code === 0 为成功 */该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南