置顶与免打扰
会话置顶在多端之间同步;免打扰会话不展示红点与角标,可保留数字。
平台调用风格
进程模型:main(客户端 + 本地库,单写者)/ preload(contextBridge 具名方法)/ renderer(薄代理)。renderer 不直连网络与数据库。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
setConversationToTop | 会话置顶/取消。 | REST(客户端) | null |
setConversationNotificationLevel | 会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。 | REST(客户端) | null |
本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
setConversationToTop | setConversationToTop | setConversationToTop | setConversationToTop | setConversationToTop | setConversationToTop | — | func |
setConversationNotificationLevel | setConversationNotificationLevel | setConversationNotificationLevel | setConversationNotificationLevel | setConversationNotificationLevel | setConversationNotificationLevel | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
setConversationToTop
会话置顶/取消。
setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
isTop | bool | 必填;字段含义见类型定义 |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.setConversationToTop(ConversationType.PRIVATE, 'user2', true); /* code === 0 为成功 */错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
setConversationNotificationLevel
会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。
setConversationNotificationLevel(conversationType: ConversationType, targetId: string, level: NotificationLevel): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
level | NotificationLevel | 必填;字段含义见类型定义 |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.setConversationNotificationLevel(ConversationType.PRIVATE, 'user2', NotificationLevel.ALL); /* code === 0 为成功 */错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南