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 theREADME.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
- Android API level 24 (in case you are using the calls SDKS)
- 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.
build.gradle
file in the dependencies
section.
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:calls-sdk-android:4.1.0'
in the dependencies section of the app-level build.gradle
file.android
section of the app level gradle file
Initialise CometChat
Theinit()
method initializes the settings required for CometChat. The init()
method takes the below parameters:
- appID - You CometChat App ID
- 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.
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.
APP_ID
with your CometChat App ID and region
with your App Region in the above code.
Register and Login your User
Once initialization is successful, you will need to create a user. To create users on the fly, you can use thecreateUser()
method. This method takes a User
object and the Auth Key
as input parameters and returns the created User
object if the request is successful.
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.
This straightforward authentication method is ideal for proof-of-concept (POC) development or during the early stages of application development. For production environments, however, we strongly recommend using an Auth Token instead of an Auth Key to ensure enhanced security.
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 Android Java UI Kit section to integrate Android Java UI Kit inside your app.