UIKit Configuration Guide

The Global IM UIKit global configuration aims to provide easy-to-use feature settings, helping you quickly build chat applications.

Configuration Overview

The Global IM UIKit global configuration is divided into the following modules. You can explore all the global configurations provided by Global IM UIKit in the respective files.

Category	Description	API Documentation	Configuration Entry
Feature Configuration	Controls theme mode, language type, image loading engine, user max cache, group max cache, group member cache, permission interceptor, etc.	FeatureConfig	ConfigCenter.getFeatureConfig()
Chat List Page Configuration	Controls supported conversation types, chat list entry provider, whether to delete notification messages when entering a conversation, etc.	ChatListConfig	ConfigCenter.getChatListConfig()
Chat Page Configuration	Controls whether to display avatars, nicknames, sets chat bubble styles, recall time, etc.	ChatConfig	ConfigCenter.getChatConfig()
User Info Configuration	Sets current user info, user info provider, group info provider, group @ info provider, etc.	UserInfoConfig	ConfigCenter.getUserInfoConfig()
Notification Configuration	Controls whether to silence notifications when receiving messages on non-chat pages, notification title types, local notification categories, notification interceptors, etc.	NotificationConfig	ConfigCenter.getNotificationConfig()
Other Global Configurations	Controls whether to enable offline prompts, message sent and read status, etc.	ConfigCenter	ConfigCenter

Modifying Global IM UIKit Configurations

Global IM UIKit provides the ConfigCenter class as the entry point for modifying SDK global configurations.

// Set language (supported: English, Chinese, follow system; default: follow system; refer to FeatureConfig.LanguageType for details)
ConfigCenter.getFeatureConfig().setLanguage(FeatureConfig.LanguageType.ENGLISH);

// Set theme type (supported: light mode, dark mode, follow system; default: follow system; refer to FeatureConfig.ThemeMode for details)
ConfigCenter.getFeatureConfig().setThemeMode(FeatureConfig.ThemeMode.THEME_LIGHT_MODE);

// Offline prompt (default: on)
ConfigCenter.setShowConnectingStatus(false);

// Message sent & read status (default: on)
ConfigCenter.setSentReadStatus(false);

// Set chat list delayed refresh time (to prevent lag due to excessive messages)
ConfigCenter.getChatListConfig().setSupportedTypes(new Conversation.ConversationType[] { Conversation.ConversationType.PRIVATE,
                            Conversation.ConversationType.GROUP });

// Whether to display your own avatar in private chats (default: off)
ConfigCenter.getChatConfig().setDisplayOwnAvatarInPrivateChat(true);

// The avatar in the chat list is displayed as a circle by default, which can be changed to a rectangle.
ConfigCenter.getFeatureConfig().setKitImageEngine(new GlideKitImageEngine() {
        @Override
        public void loadConversationListPortrait(@NonNull Context context, @NonNull String url, @NonNull ImageView imageView, Conversation conversation) {
            Glide.with(context).load(url)
                    .into(imageView);
        }
    });

// The avatar in the chat page is displayed as a circle by default, which can be changed to a rectangle.
ConfigCenter.getFeatureConfig().setKitImageEngine(new GlideKitImageEngine() {
        @Override
        public void loadConversationPortrait(@NonNull Context context, @NonNull String url, @NonNull ImageView imageView, Message message) {
            Glide.with(context).load(url)
                    .into(imageView);
        }
    });

// Set no notification when receiving messages on non-chat pages in the foreground.
ConfigCenter.getNotificationConfig().setForegroundOtherPageAction(ForegroundOtherPageAction.Silent);

// Set current user info
ConfigCenter.getUserInfoConfig().setCurrentUserInfo(new UserInfo("userId", "userName", Uri.parse("https:image")));

Verifying Global IM UIKit Configurations

Global IM UIKit configurations are applied in real-time. Modified configurations will take effect during the next UI refresh or operation. It is recommended to complete all configurations after initializing Global IM UIKit.