置顶与免打扰

会话置顶在多端之间同步;免打扰会话不展示红点与角标,可保留数字。

契约预留

本平台为 reserved:以下签名来自已冻结绑定,示例为契约样例,不承诺可运行。

平台调用风格

异步风格:Promise<RcResult<T>>(不 reject;错误码在 RcResult.code);uint64/int64 映射为 number,超出安全整数时由实现改用 string。

接口一览​

操作语义传输返回
setConversationToTop会话置顶/取消。REST(客户端)null
setConversationNotificationLevel会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。REST(客户端)null

本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
setConversationToTopsetConversationToTopsetConversationToTopsetConversationToTopsetConversationToTopsetConversationToTop—func
setConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevelsetConversationNotificationLevel—func

方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。

setConversationToTop​

会话置顶/取消。

setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean): Promise<RcResult<void>>
REST(客户端)幂等since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
isTopbool必填;字段含义见类型定义
返回

null 无返回数据;成功与否通过错误码判断

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.setConversationToTop(ConversationType.PRIVATE, 'user2', true);
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

setConversationNotificationLevel​

会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。

setConversationNotificationLevel(conversationType: ConversationType, targetId: string, level: NotificationLevel): Promise<RcResult<void>>
REST(客户端)幂等since 1.0.0
参数
参数类型说明
conversationTypeConversationType必填;会话类型枚举(ConversationType)
targetIdstring必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId
levelNotificationLevel必填;字段含义见类型定义
返回

null 无返回数据;成功与否通过错误码判断

示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.setConversationNotificationLevel(ConversationType.PRIVATE, 'user2', NotificationLevel.ALL);
if (res.code !== 0) { console.error(res.msg); }
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限

相关文档​