README.md

Android Sample App by CometChat

This is a reference application showcasing the integration of CometChat's Android UI Kit within an Android framework. It provides developers with examples of implementing real-time messaging and voice and video calling features in their own Android-based applications.

Prerequisites

• Android Studio
• Android Device or emulator with Android version 6.0 or above.
• Java 8 or above.
• Sign up for a CometChat account to get your app credentials: App ID, Region, and Auth Key

Installation

1. Clone the repository:

   git clone https://github.com/cometchat/cometchat-sample-app-android-java.git
   

2. In Android Studio, open the project cometchat-sample-app-android-java

3. Enter your CometChat App ID, Region, and Auth Key in the AppConstants.java file:

   cometchat-sample-app-android-java/app/src/main/java/com/cometchat/javasampleapp/AppConstants.java

   Lines 3 to 11 in b78f03f

   	public class AppConstants {
   	public static final String APP_ID = "XXXXXXXXXXXXXXXXX";
   	public static final String AUTH_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
   	public static final String REGION = "XX";
   	}

4. If your app is created before August 12th, 2024 then change the sample data URL to https://assets.cometchat.io/sampleapp/v1/sampledata.json in the app/src/main/java/com/cometchat/javasampleapp/constants/StringConstants.java file:

   cometchat-sample-app-android-java/app/src/main/java/com/cometchat/javasampleapp/constants/StringConstants.java

   Lines 12 to 14 in b78f03f

   	public static final String KEY_USER = "users";
   	public static final String SAMPLE_APP_USERS_URL = "https://assets.cometchat.io/sampleapp/sampledata.json";
   	public static final String UID = "uid";

5. Run the app on a device or emulator.

Help and Support

For issues running the project or integrating with our UI Kits, consult our documentation or create a support ticket or seek real-time support via the CometChat Dashboard.