matrix-sdk-android

Welcome to the matrix-sdk-android documentation!

This pages list the complete API that this SDK is exposing to a client application.

We are still building the documentation, so everything is not documented yet.

A few entry points:

Matrix: The app will have to create and manage a Matrix object.
From this Matrix object, you will be able to get various services, including the AuthenticationService.
With this AuthenticationService you will be able to get an existing Session, or create one using a LoginWizard or a RegistrationWizard, which will finally give you a Session.
From the Session, you will be able to retrieve many Services, including the RoomService.
From the RoomService, you will be able to list the rooms, create a Room, and get a specific Room.
And from a Room, you will be able to do many things, including get a Timeline, send messages, etc.

Please read the whole documentation to learn more!

Packages

org.matrix.android.sdk.api

This is the root package of the API exposed by this SDK.

org.matrix.android.sdk.api.account

org.matrix.android.sdk.api.auth

org.matrix.android.sdk.api.auth.data

org.matrix.android.sdk.api.auth.login

org.matrix.android.sdk.api.auth.registration

org.matrix.android.sdk.api.auth.wellknown

org.matrix.android.sdk.api.cache

org.matrix.android.sdk.api.comparators

org.matrix.android.sdk.api.crypto

org.matrix.android.sdk.api.debug

org.matrix.android.sdk.api.extensions

org.matrix.android.sdk.api.failure

org.matrix.android.sdk.api.federation

org.matrix.android.sdk.api.interfaces

org.matrix.android.sdk.api.listeners

org.matrix.android.sdk.api.logger

org.matrix.android.sdk.api.metrics

org.matrix.android.sdk.api.network

org.matrix.android.sdk.api.network.ssl

org.matrix.android.sdk.api.provider

org.matrix.android.sdk.api.query

org.matrix.android.sdk.api.raw

org.matrix.android.sdk.api.rendezvous

org.matrix.android.sdk.api.rendezvous.channels

org.matrix.android.sdk.api.rendezvous.model

org.matrix.android.sdk.api.rendezvous.transports

org.matrix.android.sdk.api.securestorage

org.matrix.android.sdk.api.session

org.matrix.android.sdk.api.session.account

org.matrix.android.sdk.api.session.accountdata

org.matrix.android.sdk.api.session.cache

org.matrix.android.sdk.api.session.call

org.matrix.android.sdk.api.session.content

org.matrix.android.sdk.api.session.contentscanner

org.matrix.android.sdk.api.session.crypto

org.matrix.android.sdk.api.session.crypto.attachments

org.matrix.android.sdk.api.session.crypto.crosssigning

org.matrix.android.sdk.api.session.crypto.keysbackup

org.matrix.android.sdk.api.session.crypto.keyshare

org.matrix.android.sdk.api.session.crypto.model

org.matrix.android.sdk.api.session.crypto.verification

org.matrix.android.sdk.api.session.events

org.matrix.android.sdk.api.session.events.model

org.matrix.android.sdk.api.session.events.model.content

org.matrix.android.sdk.api.session.file

org.matrix.android.sdk.api.session.homeserver

org.matrix.android.sdk.api.session.identity

org.matrix.android.sdk.api.session.identity.model

org.matrix.android.sdk.api.session.integrationmanager

org.matrix.android.sdk.api.session.media

org.matrix.android.sdk.api.session.openid

org.matrix.android.sdk.api.session.permalinks

org.matrix.android.sdk.api.session.presence

org.matrix.android.sdk.api.session.presence.model

org.matrix.android.sdk.api.session.profile

org.matrix.android.sdk.api.session.pushers

org.matrix.android.sdk.api.session.pushrules

org.matrix.android.sdk.api.session.pushrules.rest

org.matrix.android.sdk.api.session.room

org.matrix.android.sdk.api.session.room.accountdata

org.matrix.android.sdk.api.session.room.alias

org.matrix.android.sdk.api.session.room.call

org.matrix.android.sdk.api.session.room.crypto

org.matrix.android.sdk.api.session.room.failure

org.matrix.android.sdk.api.session.room.location

org.matrix.android.sdk.api.session.room.members

org.matrix.android.sdk.api.session.room.model

org.matrix.android.sdk.api.session.room.model.call

org.matrix.android.sdk.api.session.room.model.create

org.matrix.android.sdk.api.session.room.model.livelocation

org.matrix.android.sdk.api.session.room.model.localecho

org.matrix.android.sdk.api.session.room.model.message

org.matrix.android.sdk.api.session.room.model.relation

org.matrix.android.sdk.api.session.room.model.roomdirectory

org.matrix.android.sdk.api.session.room.model.tag

org.matrix.android.sdk.api.session.room.model.thirdparty

org.matrix.android.sdk.api.session.room.model.tombstone

org.matrix.android.sdk.api.session.room.notification

org.matrix.android.sdk.api.session.room.peeking

org.matrix.android.sdk.api.session.room.poll

org.matrix.android.sdk.api.session.room.powerlevels

org.matrix.android.sdk.api.session.room.read

org.matrix.android.sdk.api.session.room.reporting

org.matrix.android.sdk.api.session.room.send

org.matrix.android.sdk.api.session.room.sender

org.matrix.android.sdk.api.session.room.state

org.matrix.android.sdk.api.session.room.summary

org.matrix.android.sdk.api.session.room.taggedevents

org.matrix.android.sdk.api.session.room.tags

org.matrix.android.sdk.api.session.room.threads

org.matrix.android.sdk.api.session.room.threads.local

org.matrix.android.sdk.api.session.room.threads.model

org.matrix.android.sdk.api.session.room.timeline

org.matrix.android.sdk.api.session.room.typing

org.matrix.android.sdk.api.session.room.uploads

org.matrix.android.sdk.api.session.room.version

org.matrix.android.sdk.api.session.search

org.matrix.android.sdk.api.session.securestorage

org.matrix.android.sdk.api.session.signout

org.matrix.android.sdk.api.session.space

org.matrix.android.sdk.api.session.space.model

org.matrix.android.sdk.api.session.space.peeking

org.matrix.android.sdk.api.session.statistics

org.matrix.android.sdk.api.session.sync

org.matrix.android.sdk.api.session.sync.filter

org.matrix.android.sdk.api.session.sync.job

org.matrix.android.sdk.api.session.sync.model

org.matrix.android.sdk.api.session.terms

org.matrix.android.sdk.api.session.thirdparty

org.matrix.android.sdk.api.session.thirdparty.model

org.matrix.android.sdk.api.session.threads

org.matrix.android.sdk.api.session.typing

org.matrix.android.sdk.api.session.uia

org.matrix.android.sdk.api.session.uia.exceptions

org.matrix.android.sdk.api.session.user

org.matrix.android.sdk.api.session.user.model

org.matrix.android.sdk.api.session.widgets

org.matrix.android.sdk.api.session.widgets.model

org.matrix.android.sdk.api.settings

org.matrix.android.sdk.api.util

org.matrix.android.sdk.internal.crypto

org.matrix.android.sdk.internal.crypto.algorithms.megolm

org.matrix.android.sdk.internal.crypto.model

org.matrix.android.sdk.internal.crypto.store

org.matrix.android.sdk.internal.crypto.store.db

org.matrix.android.sdk.internal.crypto.store.db.migration.rust

org.matrix.android.sdk.internal.crypto.tasks

org.matrix.android.sdk.internal.crypto.verification

org.matrix.android.sdk.internal.database

org.matrix.android.sdk.internal.network

org.matrix.android.sdk.internal.session

org.matrix.android.sdk.internal.session.room.poll

org.matrix.android.sdk.internal.session.room.relation.poll

org.matrix.android.sdk.userstories

This package contains some user stories (Us prefix) of the SDK usage. You will find example of what it is possible to do with the SDK and the API which can be used to do it.