Skip to main content
Version: 5.21.0

Introduction

Where to start

Minimal SDK integration path: InstallationQuick startAuthorizationDisplaying the chatNotifications.

Before you start, get the providerUid and cloudHost from your edna Chat Center administrator — they are displayed on the Android channel's "Setup" tab (details). Without them, SDK initialization is impossible. If you do not have access to the admin panel, write to edna support.

About the product

edna Chat Center Android SDK embeds an operator chat into an Android app: two-way messaging, push notifications, file uploads, voice messages, surveys.

Minimum requirements: Android 5.0+ (API 21), Kotlin 1.9.10+. UI built on XML Views (Jetpack Compose support is in development).

Push notifications: FCM is included in the SDK (you need google-services.json and the com.google.gms.google-services plugin); HMS is connected separately — see Notifications. The server side is configured by the administrator in the edna Chat Center admin panel: Android, Huawei, push template.

Chat customization

Colors, typography, images, component styles, and flow scenarios are configured through the SDK design system. The full list of tokens is in the Design system section.

Not everything in the UI is customizable

Only design-system tokens and styles are changeable. System icons and some service screens cannot be customized. A number of public API fields are ignored in the current version — see the list in Known limitations.

Quick lookup: what I want to do

TaskMethod / classSection
Add the SDK to a projectimplementation 'edna.chatcenter.ui.android:release:<version>' (current version — in Installation)Installation
Initialize the SDKChatCenterUI(context).apply { init(providerUid, config) }Quick start
Authorize the userauthorize(client: ChatUser, auth: ChatAuth?)Authorization
Open the chat screengetChatFragment() / getChatActivity()Displaying the chat
Send a message programmaticallysend(ChatMessage.TextMessage("..."))API reference → Messages
Prefill the input fieldprefill(message)API reference → Messages
Get the unread counterUnreadMessagesController.INSTANCE.pushesCountAPI reference
Subscribe to SDK eventssetChatCenterUIListener(listener)Advanced settings
Configure push notificationsChatCenterUI.setFCMToken(token, context)Notifications
Handle a pushhandleFCMMessage(data)Notifications
Customize appearancetheme = ChatTheme(...)Themes
Enable loggingChatLoggerConfig(logLevel = ChatLogLevel.DEBUG)Advanced settings
Sign out (with push unsubscribe)logout()Authorization
Sign out (locally only)deauthorizeUser()Authorization
Find out the SDK versionchatCenterUI.versionAPI reference
Learn about SDK permissionsPermissions, permissionsDescriptionDialogsEnabledPermissions

Documentation navigation

SectionDescription
InstallationDependency setup, Gradle, ProGuard
Quick startStep-by-step integration of a basic chat
AuthorizationChatUser, ChatAuth, logout
Displaying the chatFragment vs Activity
NotificationsFCM, HMS, push handling
LifecycleIntegrating with the app lifecycle
API referenceFull reference of SDK methods
ThemesUI customization
LocalizationString resources
Error handlingDiagnostics and troubleshooting
TroubleshootingSymptoms, checklists, common errors