Run the Sample Project

Prerequisites

• Android simulator or real device installed with Android 5.0+.
• Android Studio (Latest version recommended).
• Java Development Kit (JDK). See Android official documentation for a supported version.
• A valid Agora account.
• Open the specified ports in Firewall Requirements if your network has a firewall.

Implement real-time messaging

1. Create an Agora project

Create a project in Agora Console, as follows:

1. Log in to Console, and click in the left navigation menu to enter the Project Management page.

2. Click Create.

   

3. Enter your project name, and select APP ID for the authentication mechanism in the pop-up window.

   Agora recommends using an App ID for authentication only in a test environment, or if your project has low security requirements.

4. Click Submit. You can see the created project on the Project Management page.

2. Get an App ID

Agora automatically assigns each project an App ID as a unique identifier.

To copy this App ID, find your project on the Project Management page in Agora Console, and click the eye icon to the right of the App ID.

3. Integrate the RTM SDK

Refer to the following steps to integrate the RTM SDK into the sample project:

1. Download the RTM repository on Github, and locate the Agora-RTM-Tutorial-Android folder.
2. Download the latest version of Real time Messaging SDK (Android Java) and extract the files.
3. Copy the *.jar file in the SDK folder into the libs directory of the project folder, and copy the x86_64, x86, arm64-v8a, and armeabi-v7a folders to Agora-RTM-Tutorial-Android\app\src\main\jniLibs.

4. Run the sample project

Refer to the following steps to run the sample project:

1. Open app with Android Studio. Android automatically syncs the project with gradle.

2. After successful syncing, enter your App ID in app > res > values > strings_config.xml.

    <?xml version="1.0" encoding="utf-8"?>
    <resources>
            <string translatable="false" name="agora_app_id">Your App ID</string>
    </resources>

3. Compile and run the sample project. Enter any string as the user ID (such as userA) and click Login to log in to the RTM system.

   You need to specify the user ID yourself. The user ID supports the following character set:

   • All lowercase English letters: a to z
   • All uppercase English letters: A to Z
   • All numeric characters: 0 to 9
   • The space character.
   • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

Expected result