Enable Offline Support - CometChat Docs

AI Integration Quick Reference

// 1. Build an OfflineConfig (off by default — call enabled(true)).
val offlineConfig = OfflineConfig.Builder()
    .enabled(true)
    .build()

// 2. Attach it to AppSettings.
val appSettings = AppSettings.AppSettingsBuilder()
    .setRegion("REGION")
    .setOfflineConfig(offlineConfig)   // explicit config; enabled value wins
    // .offline(true)                  // shorthand: enable with all defaults
    .build()

// 3. Pass the settings to init.
CometChat.init(context, "APP_ID", appSettings, callbackListener)

// 4. Verify it is active for the logged-in user.
val active = CometChat.isOfflineEnabled()   // Boolean

Offline support is off by default. You turn it on once, at initialization, by attaching an OfflineConfig to your AppSettings. Until you do, the SDK behaves exactly as before. This page covers the minimal setup; for every tunable option see the Configuration & API Reference.

Requirements

Offline support requires CometChat Android SDK 5.1.0 or later (minSdk 21). Add or update the dependency:

Groovy
Kotlin DSL

implementation "com.cometchat:chat-sdk-android:5.1.0"

implementation("com.cometchat:chat-sdk-android:5.1.0")

If you are new to the SDK, complete the standard setup first; the steps below only add offline configuration to your existing init.

Build an OfflineConfig

Construct an OfflineConfig with its fluent Builder and call enabled(true). Every other field has a sensible default, so set only what you need.

Java
Kotlin

OfflineConfig offlineConfig = new OfflineConfig.Builder()
        .enabled(true)
        .build();

val offlineConfig = OfflineConfig.Builder()
    .enabled(true)
    .build()

Attach it to AppSettings

Pass the config to AppSettingsBuilder.setOfflineConfig(...). To enable with all defaults instead of building a config, use the offline(boolean) shorthand.

Java
Kotlin

AppSettings appSettings = new AppSettings.AppSettingsBuilder()
        .setRegion("REGION")
        .setOfflineConfig(offlineConfig)   // explicit config
        // .offline(true)                  // shorthand: enable with defaults
        .build();

val appSettings = AppSettings.AppSettingsBuilder()
    .setRegion("REGION")
    .setOfflineConfig(offlineConfig)       // explicit config
    // .offline(true)                      // shorthand: enable with defaults
    .build()

If you call both setOfflineConfig(...) and offline(boolean), the explicit OfflineConfig wins — its enabled value is authoritative.

Initialize the SDK

Pass the settings to CometChat.init(...) as you do today. No other call changes.

Java
Kotlin

CometChat.init(context, "APP_ID", appSettings, new CometChat.CallbackListener<String>() {
    @Override
    public void onSuccess(String successMessage) {
        Log.d(TAG, "Initialization completed successfully");
    }

    @Override
    public void onError(CometChatException e) {
        Log.e(TAG, "Initialization failed: " + e.getMessage());
    }
});

CometChat.init(context, "APP_ID", appSettings, object : CometChat.CallbackListener<String>() {
    override fun onSuccess(successMessage: String?) {
        Log.d(TAG, "Initialization completed successfully")
    }

    override fun onError(e: CometChatException) {
        Log.e(TAG, "Initialization failed: ${e?.message}")
    }
})

Verify it is active

Call CometChat.isOfflineEnabled(). It returns true only while offline support is actually active for the logged-in user. It is false before anyone logs in (even when you enabled it in AppSettings), after logout or session expiry, and when the encrypted cache cannot open. Read it at the moment of each decision and keep no copy of the result.

Java
Kotlin

boolean active = CometChat.isOfflineEnabled();
Log.d(TAG, "Offline support active: " + active);

val active = CometChat.isOfflineEnabled()
Log.d(TAG, "Offline support active: $active")

Next steps

Offline support is now active for the logged-in user. Continue with Show Cached Data to adopt the new fetch listeners, and Send While Offline for the durable outbox. Tune caps, TTLs, media, and encryption from the Configuration & API Reference.

​Next steps

Next steps