crtn32002 / matrix-android-sdk2

Matrix SDK for Android, extracted from the Element Android application

matrix-android-sdk2

Matrix SDK for Android, extracted from the Element Android application.

The SDK is still in beta, and replaces the legacy Matrix Android SDK provided by Matrix.org

About

This repository contains the matrix-android-sdk extracted from the project Element Android

Please open any issue in the Element Android project: Create an issue

How to integrate the SDK in your application

Quick start

To integrate the SDK to your application, add the following gradle dependency to the build.gradle of your application module:

implementation 'com.github.matrix-org:matrix-android-sdk2:v0.0.1'

Latest version:

You need to add Jitpack as a repository in your main build.gradle file. Please follow instructions here: https://jitpack.io/#matrix-org/matrix-android-sdk2

Sample application

You can have a look on the sample app we have written to help starting with the new SDK: https://github.com/matrix-org/matrix-android-sdk2-sample.

This sample app is able to let the user connects to an existing account on any homeserver with password login, display the room list, display a room timeline and send message to a room.

Element Android

Element Android is the main application developed and maintained by the core team, which uses this SDK. You can find it here: https://github.com/vector-im/element-android

Migrate from legacy SDK

Sadly there is no official documentation on how to migrate from the old SDK to the new one. Because the new SDK API is totally new, we guess that there is no easy way to handle a migration.

We strongly recommend that any new applications uses this new SDK.