Skip the create new app step. Your existing v2 app can be migrated to v3. > > Follow steps mentioned in Add the CometChat dependency section below to upgrade to latest version of v3

​
Get your Application Keys

Signup for CometChat and then:
  1. Create a new app
  2. Head over to the API Keys section and note the Auth Key, App ID & Region
Minimum Requirement
  • Android API Level 21
  • Android API level 24 (in case you are using the calls SDKS)
  • Androidx Compatibility

​
Add the CometChat Dependency

​
Gradle

First, add the repository URL to the project level build.gradle file in the repositories block under the allprojects section: 
allprojects {
  repositories {
    maven {
      url "https://dl.cloudsmith.io/public/cometchat/cometchat/maven/"
    }
  }
}
Then, add CometChat to the app level build.gradle file in the dependencies section. 
dependencies {
  implementation "com.cometchat:chat-sdk-android:4.1.2"
}
In case you plan to use the calling feature, please add the Calling dependency implementation 'com.cometchat:calls-sdk-android:4.1.0' in the dependencies section of the app-level build.gradle file.
Finally, add the below lines android section of the app level gradle file. 
android {
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

​
Initialize CometChat

The init() method initialises the settings required for CometChat. The init() method takes the below parameters:
  1. appID - You CometChat App ID
  2. appSettings - An object of the AppSettings class can be created using the AppSettingsBuilder class. The region field is mandatory and can be set using the setRegion() method.
The AppSettings class allows you to configure three settings:
  • Region: The region where you app was created.
  • Presence Subscription : Represents the subscription type for user presence (real-time online/offline status)
  • autoEstablishSocketConnection(boolean value): This property takes a boolean value which when set to true informs the SDK to manage the web-socket connection internally. If set to false, it informs the SDK that the web-socket connection will be managed manually. The default value for this parameter is true. For more information on this, please check the Managing Web-Socket connections manually section. The default value for this property is true.
  • overrideAdminHost(adminHost: string): This method takes the admin URL as input and uses this admin URL instead of the default admin URL. This can be used in case of dedicated deployment of CometChat.
  • overrideClientHost(clientHost: string): This method takes the client URL as input and uses this client URL instead of the default client URL. This can be used in case of dedicated deployment of CometChat.
We suggest you call the init() method on app startup. 
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());
  }
});
ParameterDescription
thisAndroid context for your application
appIDCometChat App ID
appSettingAn object of the AppSettings class.

​
Auto Mode Connection

Know more about auto mode connection click here
App StateBehaviour
App in foregroundConnected with WebSocket
App in backgroundImmediately disconnected with WebSocket

​
Manual Mode Connection

Know more about manual mode connection click here
App StateBehaviour
App in foregroundCall CometChat.connect() to create the WebSocket connection
App in backgroundDisconnect the WebSocket connection if no ping is received within 30 seconds after the app goes in the background.