Repository files navigation

We are introducing a new version of the Sendbird UIKit. Version 3 features a new modular architecture with more granular components that give you enhanced flexibility to customize your web and mobile apps. Check out ourmigration guides and downloadour samples

Sendbird UIKit for Android is a development kit with an user interface that enables an easy and fast integration of standard chat features into new or existing client apps. This repository houses the UIKit source code in addition to two samples as explained below.

• uikit is where you can find the open source code. Check outUIKit Open Source Guidelines for more information regarding our stance on open source.
• uikit-samples consists of four use cases of UIKit.You can navigate to each use case through the four menus that appear when you run it.
  • Basic Usage - A sample that contains the basic usage of UIKit. Please check theREADME for details.
  • Customizations - Examples that have applied customization to UIKit. Please check theREADME for details.
  • AI Chatbot: You can chat with the AI Chatbot running on the Sendbird platform.It is disabled by default, To enable it, please check theREADME for details.
  • Sendbird Notification: You can try out Sendbird's Notification product in this sample.It is disabled by default. To enable it, please check theREADME for details.Caution: This sample is not related to push notifications. It is a demonstration of Sendbird's Notification product.

Find out more about Sendbird UIKit for Android atUIKit for Android doc. If you need any help in resolving any issues or have questions, visitour community.

This section shows you the prerequisites you need for testing Sendbird UIKit for Android sample apps.

The minimum requirements for UIKit for Android are:

• Android 5.0 (API level 21) or higher
• Java 8 or higher
• Support androidx only
• Android Gradle plugin 4.0.1 or higher
• Sendbird Chat SDK for Android 4.0.3 and later

If you would like to try the sample app specifically fit to your usage, you can do so by replacing the default sample app ID with yours, which you can obtain bycreating your Sendbird application from the dashboard. Furthermore, you could also add data of your choice on the dashboard to test. This will allow you to experience the sample app with data from your Sendbird application.

This section explains the steps you need to take before testing the sample apps.

Go to yourAndroid Studio and create a project for UIKit for Android in theProject window as follows:

1. In theWelcome to Android Studio window, clickStart a new Android Studio project.
2. In theSelect a Project Template window, selectEmpty Activity, and clickNext.
3. Enter your project name in theName field in theConfigure your project window.
4. Select your language as eitherJava orKotlin from theLanguage drop-down menu.
5. EnableUse androidx.*artifacts.
6. Select minimum API level as 21 or higher.

UIKit for Android is installed viaGradle. Begin by opening the project's top-levelbuild.gradle file and adding code blocks as below:

Note: Add the code blocks in your rootbuild.gradle file, not your modulebuild.gradle file.

allprojects {    repositories {        maven { url"https://jitpack.io" }        maven { url"https://repo.sendbird.com/public/maven" }    }}

If using Gradle 6.8 or higher, add the following to yoursettings.gradle file:

dependencyResolutionManagement {    repositories {        maven { url"https://jitpack.io" }        maven { url"https://repo.sendbird.com/public/maven" }    }}

Then, open thebuild.gradle file at the application level. ForJava andKotlin, add code blocks and dependencies as below:

Note: View binding should be enabled in yourbuild.gradle file.

applyplugin:'com.android.application'android {    buildFeatures {        viewBindingtrue    }    compileOptions {        sourceCompatibilityJavaVersion.VERSION_1_8        targetCompatibilityJavaVersion.VERSION_1_8    }}dependencies {    implementation'com.sendbird.sdk:uikit:LATEST_VERSION'}

After saving yourbuild.gradle file, click theSync button to apply all the changes.