Cometchat Android V6 Builder Settings

Companion skills: cometchat-android-v6-core (init/login), cometchat-android-v6-push (FCM/VoIP)

Purpose

Detailed reference for UIKitSettings.UIKitSettingsBuilder — all configuration options for initializing the CometChat SDK, including presence subscriptions, calling features, and host overrides.

Use this skill when

• Configuring presence subscription types (all users, roles, friends)
• Enabling calling features and configuring CallSettingsBuilder
• Overriding admin or client host URLs
• Controlling socket connection behavior
• Understanding the full UIKitSettingsBuilder API

Do not use this skill when

• Just doing basic init/login (use cometchat-android-v6-core for quick setup)
• Working with UI components or theming

1. UIKitSettingsBuilder — Complete API

import com.cometchat.uikit.core.UIKitSettings

val settings = UIKitSettings.UIKitSettingsBuilder()

    // Required
    .setAppId("APP_ID")                          // CometChat App ID
    .setRegion("us")                             // "us" or "eu"

    // Authentication (dev only — use token auth in production)
    .setAuthKey("AUTH_KEY")                      // Auth key from dashboard

    // Presence subscriptions
    .subscribePresenceForAllUsers()              // Subscribe to all users' presence
    .subscribePresenceForRoles(listOf("admin"))  // Subscribe by roles
    .subscribePresenceForFriends()               // Subscribe to friends' presence

    // Socket connection
    .setAutoEstablishSocketConnection(true)      // Auto-connect (default: true)

    // Calling
    .setEnableCalling(true)                      // Auto-init CometChatCalls SDK (default: false)
    .setCallSettingsBuilder(callSettingsBuilder)  // Custom call config (optional)

    // Host overrides (advanced — for on-premise deployments)
    .overrideAdminHost("https://custom-admin.example.com")
    .overrideClientHost("https://custom-client.example.com")

    .build()

2. Presence Subscription Types

Only one subscription type is active at a time. The last one set wins.

3. Calling Configuration

When setEnableCalling(true) is set, CometChatUIKit.init() automatically initializes the CometChatCalls SDK after the Chat SDK succeeds:

// Basic calling setup
val settings = UIKitSettings.UIKitSettingsBuilder()
    .setAppId("APP_ID")
    .setRegion("us")
    .setAuthKey("AUTH_KEY")
    .setEnableCalling(true)
    .build()

For custom call settings:

import com.cometchat.calls.core.CometChatCalls

val callSettingsBuilder = CometChatCalls.CallSettingsBuilder(context, null)
    .setDefaultAudioMode("SPEAKER")
    .startWithVideoMuted(true)

val settings = UIKitSettings.UIKitSettingsBuilder()
    .setAppId("APP_ID")
    .setRegion("us")
    .setAuthKey("AUTH_KEY")
    .setEnableCalling(true)
    .setCallSettingsBuilder(callSettingsBuilder)
    .build()

After init, retrieve the stored builder:

val builder: CometChatCalls.CallSettingsBuilder? = CometChatUIKit.getCallSettingsBuilder()

4. Checking Initialization State

// Chat SDK initialized?
CometChatUIKit.isSDKInitialized()

// Calls SDK initialized? (only true if enableCalling was true AND init succeeded)
CometChatUIKit.isCallsSDKInitialized()

5. Application-Level Init Pattern

From master-app-jetpack, the recommended pattern separates SDK init from Calls SDK init:

class MyApplication : Application() {
    fun onSDKInitialized() {
        // Called after CometChatUIKit.init() succeeds
        // CometChatCalls is auto-initialized if enableCalling = true
        // Register call listeners here
        addCallListener()
    }
}

Hard rules

• NEVER set both subscribePresenceForAllUsers() and subscribePresenceForRoles() — only the last one takes effect
• NEVER use setAuthKey() in production — use loginWithAuthToken() instead
• setEnableCalling(true) requires the CometChatCalls SDK dependency in your Gradle file
• If CometChatCalls init fails, the Chat SDK still reports success — check isCallsSDKInitialized() separately
• overrideAdminHost() and overrideClientHost() are for on-premise deployments only — do not use with cloud-hosted CometChat