This guide demonstrates how to add chat to an Android application. Before you begin, we strongly recommend you read the Key Concepts guide.
I want to integrate with my app
- Get your application keys
- Add the CometChat dependency
- Initialize CometChat
- Register and Login your user
- Integrate Our UI Kits
I want to explore a sample app (includes UI)
Import the app into Android Studio and follow the steps mentioned in the README.md file.
Java Chat App
Kotlin Chat App
Get your Application Keys
Signup for CometChat and then:
- Create a new app
- Head over to the API Keys section and note the Auth Key, App ID & Region
Minimum Requirements
- Android API Level 21
- Androidx Compatibility
Add the CometChat Dependency
First, add the repository URL to the project levelbuild.gradle file in the repositories block under the allprojects section.
allprojects {
repositories {
maven {
url "https://dl.cloudsmith.io/public/cometchat/cometchat-pro-android/maven/"
}
}
}
build.gradle file in the dependencies section.
dependencies {
implementation 'com.cometchat:pro-android-chat-sdk:2.4.2'
implementation 'com.cometchat:pro-android-calls-sdk:2.1.1'
}
v2.4+ onwards, Voice & Video Calling functionality has been moved to a separate library. In case you plan to use the calling feature, please add the Calling dependency implementation 'com.cometchat:pro-android-calls-sdk:2.1.1' in the dependencies section of the app-level build.gradle file.
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. We suggest calling the init() method on app startup .
String appID = "APP_ID"; // Replace with your App ID
String region = "REGION"; // Replace with your App Region ("eu" or "us")
AppSettings appSettings=new AppSettings.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).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")
val appSettings = AppSettings.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).build()
CometChat.init(this,appID,appSettings, 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)
}
})
APP_ID with your CometChat App ID and region with your App Region in the above code.
Register and Login your User
Once initialisation is successful, you will need to create a user.
To create users on the fly, you can use the createUser() method. This method takes an User object and the Auth Key as input parameters and returns the created User object if the request is successful.
String authKey = "AUTH_KEY"; // Replace with your App Auth Key
User user = new User();
user.setUid("user1"); // Replace with the UID for the user to be created
user.setName("Kevin"); // Replace with the name of the user
CometChat.createUser(user, authKey, new CometChat.CallbackListener<User>() {
@Override
public void onSuccess(User user) {
Log.d("createUser", user.toString());
}
@Override
public void onError(CometChatException e) {
Log.e("createUser", e.getMessage());
}
});
val authKey = "AUTH_KEY" // Replace with your App Auth Key
val user = User()
user.uid = "user1" // Replace with the UID for the user to be created
user.name = "Kevin" // Replace with the name of the user
CometChat.createUser(user, authKey, object : CometChat.CallbackListener<User>() {
override fun onSuccess(user: User) {
Log.d("createUser", user.toString())
}
override fun onError(e: CometChatException) {
Log.e("createUser", e.message)
}
})
UID and name are specified as these are mandatory fields to create a user.
Once you have created the user successfully, you will need to log the user into CometChat using the login() method.
We recommend you call the CometChat login() method once your user logs into your app. The login() method needs to be called only once.
String UID = "user1"; // Replace with the UID of the user to login
String authKey = "AUTH_KEY"; // Replace with your App Auth Key
if (CometChat.getLoggedInUser() == null) {
CometChat.login(UID, authKey, new CometChat.CallbackListener<User>() {
@Override
public void onSuccess(User user) {
Log.d(TAG, "Login Successful : " + user.toString());
}
@Override
public void onError(CometChatException e) {
Log.d(TAG, "Login failed with exception: " + e.getMessage());
}
});
} else {
// User already logged in
}
val UID:String="user1" // Replace with the UID of the user to login
val authKey:String="AUTH_KEY" // Replace with your App Auth Key
if (CometChat.getLoggedInUser() == null) {
CometChat.login(UID,authKey, object : CometChat.CallbackListener<User>() {
override fun onSuccess(p0: User?) {
Log.d(TAG, "Login Successful : " + p0?.toString())
}
override fun onError(p0: CometChatException?) {
Log.d(TAG, "Login failed with exception: " + p0?.message)
}
})
}else{
// User already logged in
}
AUTH_KEY with your App Auth Key in the above code.
The login() method returns the User object containing all the information of the logged-in user.
UID can be alphanumeric with underscore and hyphen. Spaces, punctuation and other special characters are not allowed.
Integrate our UI Kits
- Please refer Overview section to integrate Android Java UI Kit inside your app.
- Please refer Android Kotlin UI Kit section to integrate Android Kotlin UI Kit inside your app.
