跳到主要内容

配置指南

IMKit 为部分功能提供全局配置,帮助您快速构建聊天应用程序。

提示

IMKit 的 RCKitConfig 配置会实时应用,修改后的配置将在下一次 UI 刷新或操作时生效。建议在初始化 IMKit 后完成所有配置。

配置说明

IMKit 在 RCKitConfig.h 文件中定义全局配置,并按以下模块划分。您可以在对应的文件中查看 IMKit 提供的全部全局配置。

类别描述API 文档源码
消息配置控制消息的自动重发、前台提示音、合并转发、引用回复、输入状态、已读回执、消息撤回等行为。RCKitMessageConfRCKitMessageConf.h
UI 配置控制暗黑模式、布局方向、会话列表、会话页面的头像和消息、标题大小等。RCKitUIConfRCKitUIConf.h
字体配置控制字体大小。RCKitFontConfRCKitFontConf.h

修改 IMKit 配置

在 iOS 中,可使用 RCKitConfig 单例或 RCKitConfigCenter 宏修改 IMKit 功能配置。每个应用程序仅有一个 IMKit 全局配置。

配置示例:

Objective C
//消息可撤回的最大时长(秒)
RCKitConfigCenter.message.maxRecallDuration = 120;

//设为选择媒体资源时包含视频文件
RCKitConfigCenter.message.isMediaSelectorContainVideo = YES;

// 开启带引用关系信息的消息
RCKitConfigCenter.message.enableQuoteV2 = YES;

//头像显示默认为矩形,可修改为圆角显示。
RCKitConfigCenter.ui.globalMessageAvatarStyle = RC_USER_AVATAR_CYCLE;

// 二级标题,默认 fontSize 为 17 (文本消息,引用消息内容,会话列表 title)
RCKitConfigCenter.font.secondLevel = 20;

// 修改文件消息中文件类型(扩展名)对应显示的图标(Since 5.3.4)。
[RCKitConfigCenter.ui registerFileSuffixTypes:types];

RTL 布局支持

IMKit 支持 RTL(从右到左)布局,并内置阿拉伯语资源。您可以通过 RCKitUIConflayoutDirection 设置 IMKit 的布局方向。

layoutDirection 默认为 RCKitInterfaceLayoutDirectionUnspecified,此时 IMKit 会根据 App 当前的语义布局方向自动调整界面。您也可以显式指定从左到右或从右到左的布局方向:

Objective C
// 跟随 App 当前的语义布局方向(默认)
RCKitConfigCenter.ui.layoutDirection = RCKitInterfaceLayoutDirectionUnspecified;

// 强制使用从左到右布局
RCKitConfigCenter.ui.layoutDirection = RCKitInterfaceLayoutDirectionLeftToRight;

// 强制使用从右到左布局
RCKitConfigCenter.ui.layoutDirection = RCKitInterfaceLayoutDirectionRightToLeft;

建议在展示 IMKit 界面前完成布局方向配置。国际化配置请参见国际化