Installation

All Stream Android libraries are available from MavenCentral, with some of their transitive dependencies hosted on Jitpack.

Before you add Stream dependencies, update your repositories in the settings.gradle file to include these two repositories:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

Or if you’re using an older project setup, add these repositories in your project level build.gradle file:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

Check the Releases page for the latest version and the changelog.

Available Artifacts

Client

To add the low-level Chat client library to your app, open your module’s build.gradle script and add the following:

dependencies {
    implementation "io.getstream:stream-chat-android-client:$stream_version"
}

State

To use the state library in your application, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-state:$stream_version"
}

Offline Support

To use offline support in your application, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-offline:$stream_version"
}

This also adds the client library automatically.

UI Components

To use the UI Components in your application, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-ui-components:$stream_version"
}

Adding the UI Components library as a dependency will automatically include the client and offline libraries as well.

Compose UI Components

To use the Compose UI Components instead, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-compose:$stream_version"
}

Adding the Compose UI Components library as a dependency will automatically include the client and offline libraries as well.

Markdown support

We ship an additional artifact for Markdown support which can be used together with the UI Components library:

dependencies {
    implementation "stream-chat-android-markdown-transformer:$stream_version"
}

For more information see UI Components Configuration guide.

Push Notifications

We ship multiple artifacts to easily integrate Stream Chat with third party push notification providers. See the Push Notification page for more details.

Overview

Getting Started