Setup

// 1. Add dependency to build.gradle
implementation "com.cometchat:chat-sdk-android:4.2.0"

// 2. Initialize (run once at app start)
val appSettings = AppSettings.AppSettingsBuilder()
    .subscribePresenceForAllUsers()
    .setRegion("REGION")
    .build()
CometChat.init(context, "APP_ID", appSettings, callback)

// 3. Login user
CometChat.login("UID", "AUTH_KEY", callback)  // Dev only

​

Prerequisites

• App ID
• Region
• Auth Key (for development)

​

Add the CometChat Dependency

​

Gradle

allprojects {
  repositories {
    maven {
      url "https://dl.cloudsmith.io/public/cometchat/cometchat/maven/"
    }
  }
}

dependencies {
  implementation "com.cometchat:chat-sdk-android:4.2.0"
}

android {
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

​

Initialize CometChat

1. appID - Your CometChat App ID
2. appSettings - An object of the AppSettings class created using the AppSettingsBuilder class. The region field is mandatory and can be set using the setRegion() method.

• Region: The region where your app was created.
• Presence Subscription: Represents the subscription type for user presence (real-time online/offline status).
• autoEstablishSocketConnection(boolean value): When set to true, the SDK manages the WebSocket connection internally. When set to false, you must manage the WebSocket connection manually. The default value is true. For more information, see the Managing Web-Socket connections manually section.
• overrideAdminHost(adminHost: string): Takes the admin URL as input and uses it instead of the default admin URL. This is useful for dedicated deployments of CometChat.
• overrideClientHost(clientHost: string): Takes the client URL as input and uses it instead of the default client URL. This is useful for dedicated deployments of CometChat.

private String appID = "APP_ID"; // Replace with your App ID
private String region = "REGION"; // Replace with your App Region ("eu" or "us")

AppSettings appSettings= new AppSettings.AppSettingsBuilder()
  .subscribePresenceForAllUsers()
  .setRegion(region)
  .autoEstablishSocketConnection(true)
  .build();

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

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

val appID:String="APP_ID"  // Replace with your App ID
val region:String="REGION"  // Replace with your App Region ("eu" or "us")

AppSettings appSetting = AppSettings.AppSettingsBuilder()
  .setRegion(region)
  .subscribePresenceForAllUsers()
  .autoEstablishSocketConnection(true)
  .build();

CometChat.init(this,appID,appSetting, object : CometChat.CallbackListener<String>() {
  override fun onSuccess(p0: String?) {
    Log.d(TAG, "Initialization completed successfully")
  }

  override fun onError(p0: CometChatException?) {
      Log.d(TAG, "Initialization failed with exception: " + p0?.message)
    }
  }
)

​

AppSettings Options

​

Auto Mode Connection

​

Manual Mode Connection

​

Next Steps