跳到主要内容
新版 Web IMKit SDKWeb IMKit SDK 从 5.36.0 版本开始升级了 UI 和 SDK 结构。如果您集成的版本低于 5.36.0,请参考旧版 Web IMKit 文档

预设开关

Web IMKit 提供预设开关,用于控制连接状态提示、消息状态、引用消息、消息回应等功能。开关定义可通过 RCKitCommand 枚举获取。

预设开关列表

预设开关默认值说明
RCKitCommand.SHOW_CONNECTION_STATUStrue是否在开启的会话窗口中显示连接状态变更提醒。
RCKitCommand.SHOW_MESSAGE_STATEfalse是否显示消息的已读状态。
当功能关闭时,消息气泡中将仅展示消息的发送状态。
RCKitCommand.FOCUS_ON_LATEST_MESSAGEtrue进入会话时是否默认展示最新消息。
仅 Electron 平台支持修改;Web 平台默认展示最新消息,修改无效。
RCKitCommand.AT_ALLfalse是否支持群聊内 @ 全部成员功能。
RCKitCommand.SHOW_USER_ONLINE_STATEfalse是否显示用户在线状态。
RCKitCommand.PROMPT_SENDER_WHEN_QUOTE_MESSAGEfalse引用或回复消息时,默认 @ 消息发送者。
RCKitCommand.DELETE_MESSAGES_WHILE_DELETE_CONVERSATIONtrue删除会话的同时,是否删除本地与远端服务器存储的消息。
RCKitCommand.USE_QUOTE_MESSAGE_V2false启用引用消息升级版本,启用后支持回复包含 quoteInfo 引用关系信息的图片、文件等类型消息。
RCKitCommand.MESSAGE_REACTION_ENABLEDfalse是否启用消息回应功能。启用后,消息气泡中可展示回应入口、回应统计和回应详情入口。
RCKitCommand.SHOW_MESSAGE_REACT_USERSfalse是否在消息气泡中展示回应用户名称列表。仅在 RCKitCommand.MESSAGE_REACTION_ENABLED 开启后生效。
提示

消息回应功能默认关闭。如需在消息气泡中展示回应能力,请在 kitApp.ready() 前显式开启 RCKitCommand.MESSAGE_REACTION_ENABLED。如需展示回应用户名称列表,还需要同时开启 RCKitCommand.SHOW_MESSAGE_REACT_USERS

修改开关状态

请在 kitApp.ready() 之前修改开关状态。kitApp.ready() 调用后再修改,开关状态不会生效。

RCKitCommand.SHOW_CONNECTION_STATUS 开关为例,修改开关状态的代码如下:

JavaScript
import { RCKitCommand } from '@rongcloud/im-kit';

kitApp.setCommandSwitch(RCKitCommand.SHOW_CONNECTION_STATUS, false);

开启消息回应能力的代码如下:

JavaScript
import { RCKitCommand } from '@rongcloud/im-kit';

kitApp.setCommandSwitch(RCKitCommand.MESSAGE_REACTION_ENABLED, true);
kitApp.setCommandSwitch(RCKitCommand.SHOW_MESSAGE_REACT_USERS, true);

获取开关状态

JavaScript
import { RCKitCommand } from '@rongcloud/im-kit';

const bool = kitApp.getCommandSwitch(RCKitCommand.SHOW_CONNECTION_STATUS);