Matrix/element-android-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-android.git synced 2024-11-29 15:40:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
c0f3f394ac
element-android-Github/matrix-sdk-android/docs/modules.md
Benoit Marty 27dcb6ef9c Add a note when generated from this project. 
A change will have to be done on the SDK project to remove this line before generated the documentation.
2022-05-11 11:14:45 +02:00

1.4 KiB
Raw Blame History

Module matrix-sdk-android

Note: You are viewing the nightly documentation of the Android Matrix SDK library. The documentation of the released library can be found here: https://matrix-org.github.io/matrix-android-sdk2/

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!