Matrix Android SDK

https://matrix-org.github.io/matrix-android-sdk2
Admin
A comprehensive Android Software Development Kit (SDK) providing APIs and tools for building...
Tokens:975,820
Snippets:5,462
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### WellKnownBaseConfig JSON Example

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.data/-well-known-base-config/index

Provides an example JSON payload for the `WellKnownBaseConfig`. This illustrates how the server discovery information, specifically the base URL, is expected to be formatted when received by the client.

```json
{
    "base_url": "https://vector.im"
}
```

--------------------------------

### User Stories - Matrix Initialization

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.registration/-stage/-dummy/index

User story 'Us000InitMatrix' outlines the initial setup and connection process for a Matrix client. This involves establishing a connection to the Matrix homeserver.

```plaintext
Us000InitMatrix
```

--------------------------------

### User Stories - Initialization and Authentication

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/-local-notification-settings-content/-local-notification-settings-content

Defines user stories related to the initial setup and authentication process within the Matrix SDK. These cover initializing the SDK, signing in, verifying sessions, and signing out.

```kotlin
org.matrix.android.sdk.userstories.Us000InitMatrix
org.matrix.android.sdk.userstories.Us100SignIn
org.matrix.android.sdk.userstories.Us150VerifySession
org.matrix.android.sdk.userstories.Us190SignOut
```

--------------------------------

### Crypto Logging Setup

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.content/-content-upload-state-tracker/-update-listener/index

Allows setting up a Rust logger for cryptographic operations. This is crucial for debugging and monitoring crypto-related activities within the SDK.

```kotlin
/**
 * Sets the Rust logger for crypto operations.
 * @param rustLogger The logger instance to use.
 */
fun setRustLogger(rustLogger: Any)
```

--------------------------------

### Realm Database Compaction on Launch

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.data/-well-known-base-config/index

Introduces `RealmCompactOnLaunch` for handling Realm database compaction when the application starts. This is a performance optimization technique to reduce database size and improve read/write operations.

```kotlin
org.matrix.android.sdk.internal.database.RealmCompactOnLaunch
```

--------------------------------

### Crypto Logger Setup

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.registration/-stage/-dummy/index

Configuration for the crypto logger. Allows setting a Rust-based logger for cryptographic operations, aiding in debugging and monitoring security-related events.

```kotlin
object CryptoLogger {
    fun setRustLogger()
}
```

--------------------------------

### Manage Database Compaction

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.integrationmanager/-integration-manager-config/-kind/index

Implements `RealmCompactOnLaunch` for performing database compaction when the application starts, ensuring database integrity and performance.

```java
org.matrix.android.sdk.internal.database
RealmCompactOnLaunch
```

--------------------------------

### Crypto Logger Setup

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.content/-content-upload-state-tracker/-update-listener/index

Allows setting a logger for Rust-based crypto operations. This is essential for debugging and monitoring the cryptographic functions within the SDK.

```kotlin
fun setRustLogger(logger: Any)
```

--------------------------------

### User Stories for Matrix SDK (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.roomdirectory/-public-rooms-params/index

Lists user stories representing common workflows and functionalities within the Matrix SDK. These stories serve as high-level use cases, guiding development and testing. Examples include signing in, room management, and notifications.

```kotlin
object UserStories {
    const val Us000InitMatrix = "Initialize Matrix SDK"
    const val Us100SignIn = "Sign in to Matrix"
    const val Us150VerifySession = "Verify session"
    const val Us190SignOut = "Sign out from Matrix"
    const val Us200RoomList = "View room list"
    const val Us300RoomTimeline = "View room timeline"
    const val Us350RoomTimelineFromPermalink = "View room timeline from permalink"
    const val Us400RoomSendContent = "Send content to room"
    const val Us500Notification = "Handle notifications"
    const val Us600SyncWithTheServer = "Sync with the server"
}

```

--------------------------------

### User Stories (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.create/-create-room-preset/-p-r-e-s-e-t_-t-r-u-s-t-e-d_-p-r-i-v-a-t-e_-c-h-a-t/index

Defines user stories as constants, representing common user workflows within the Matrix application. Examples include `Us100SignIn`, `Us200RoomList`, and `Us300RoomTimeline`, aiding in feature development and testing.

```kotlin
const val Us000InitMatrix = "Us000InitMatrix"
const val Us100SignIn = "Us100SignIn"
const val Us150VerifySession = "Us150VerifySession"
// ... other user stories
```

--------------------------------

### Get Decimal and Emoji Code Representations

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.keyshare/-gossiping-request-listener/index

Functions to get decimal and emoji code representations of verification data. Useful for displaying verification codes to users.

```kotlin
fun getDecimalCodeRepresentation(data: String): String
fun getEmojiCodeRepresentation(data: String): List<String>
```

--------------------------------

### Crypto Initialization and Logging

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth/-token-based-auth/index

Contains functions for initializing the crypto module, setting up Rust logging, and managing user identities within the encryption system.

```kotlin
package org.matrix.android.sdk.internal.crypto

/**
 * Sets the Rust logger for the crypto module.
 * @param rustLogger An implementation of the Rust logger.
 */
fun setRustLogger(rustLogger: Any) {
    // Implementation details for setRustLogger
}

// Placeholder for UserIdentities class
class UserIdentities

```

--------------------------------

### Create Room APIs

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.keysbackup/-keys-backup-state/-will-back-up/index

APIs for creating new rooms with various configurations and presets.

```APIDOC
## Create Room APIs

APIs for creating new rooms.

### Create Room Parameters

Defines parameters for creating a new room, including name, visibility, initial members, and presets.

### Create Room Presets

Provides predefined room creation presets, such as private chat and public chat.
```

--------------------------------

### Get Emoji Code Representation (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.failure/is-username-in-use

Utility function to get the decimal code representation of an emoji character. This can be useful for internal processing or debugging of text containing emojis.

```kotlin
fun getEmojiCodeRepresentation(emoji: Char): String {
    // Implementation to get the decimal code of an emoji.
    return emoji.code.toString()
}
```

--------------------------------

### Create Room Parameters API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.sync/-initial-sync-step/-importing-account-joined-rooms/index

Defines parameters for creating new Matrix rooms, including presets and visibility settings.

```APIDOC
## Create Room Parameters API

### Description
This API defines the structure for parameters used when creating a new Matrix room. It allows specifying room name, topic, visibility, presets, and other configuration options.

### Data Models
- **CreateRoomParams**: The main class for specifying room creation parameters.
- **CreateRoomPreset**: Enum for predefined room configurations.
  - **PRESET_PRIVATE_CHAT**: For private one-on-one or group chats.
  - **PRESET_PUBLIC_CHAT**: For public rooms discoverable by anyone.
  - **PRESET_TRUSTED_PRIVATE_CHAT**: For private chats with trusted users.
- **RestrictedRoomPreset**: Defines presets for rooms that are restricted, often used within spaces.

### Example Usage
```kotlin
val createParams = CreateRoomParams(
    name = "My New Public Room",
    preset = CreateRoomPreset.PRESET_PUBLIC_CHAT,
    isPublic = true,
    topic = "Welcome to our public room!"
)

session.createRoom(createParams)
```
```

--------------------------------

### Get Emoji Decimal Code Representation (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.failure/is-username-in-use

Utility function to get the decimal code representation of an emoji character. This is similar to `getEmojiCodeRepresentation` but might imply a specific format or context.

```kotlin
fun getDecimalCodeRepresentation(emoji: Char): String {
    // Implementation to get the decimal code of an emoji.
    return emoji.code.toString()
}
```

--------------------------------

### Room Creation and Configuration APIs

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.events.model/is-sticker

APIs for creating new rooms and configuring their properties like preset and join rules.

```APIDOC
## Create Room APIs

### Description
APIs for creating new Matrix rooms, allowing configuration of presets, initial members, and other room settings.

### Method
N/A (Class-based API)

### Endpoint
N/A (Class-based API)

### Parameters
None

### Request Example
```kotlin
// Example of creating a public chat room
val params = CreateRoomParams.Builder()
    .setPreset(CreateRoomPreset.PRESET_PUBLIC_CHAT)
    .addInvitedRoomMember("@user:matrix.org")
    .build()
val roomId = createRoomService.createRoom(params)
```

### Response
#### Success Response (200)
- **String** - The ID of the newly created room.

#### Response Example
```json
"!newRoomId:matrix.org"
```

## Room Join Rules API

### Description
APIs for defining and managing the rules for joining a room, such as public, invite-only, or restricted.

### Method
N/A (Class-based API)

### Endpoint
N/A (Class-based API)

### Parameters
None

### Request Example
```kotlin
// Example of setting join rules for a public room
val joinRulesContent = RoomJoinRulesContent(RoomJoinRules.PUBLIC)
```

### Response
#### Success Response (200)
- **RoomJoinRulesContent** (Object) - Represents the room's join rules.

#### Response Example
```json
{
  "join_rule": "public"
}
```
```

--------------------------------

### Get SDK Version Information in Matrix SDK

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.space/-space/index

This class provides a mechanism to get the Android SDK version of the application. It's useful for compatibility checks and for reporting information to servers or analytics.

```kotlin
interface BuildVersionSdkIntProvider {
    fun get(): Int
}

class DefaultBuildVersionSdkIntProvider(private val context: Context) : BuildVersionSdkIntProvider {
    override fun get(): Int = context.applicationInfo.targetSdkVersion
}
```

--------------------------------

### Get Package Info Compat (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.failure/is-username-in-use

Compat utility to get package information, handling differences across Android versions. This is useful for retrieving details like version codes and names.

```kotlin
fun Context.getApplicationInfoCompat(packageName: String, flags: Int): ApplicationInfo? {
    return try {
        packageManager.getApplicationInfo(packageName, flags)
    } catch (e: PackageManager.NameNotFoundException) {
        null
    }
}
```

--------------------------------

### Get Decimal and Emoji Code Representations

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.content/-content-url-resolver/-thumbnail-method/value-of

Provides methods to get the decimal and emoji code representations of verification data. Useful for displaying verification information to the user.

```kotlin
fun getDecimalCodeRepresentation(data: VerificationData): String
fun getEmojiCodeRepresentation(data: VerificationData): String
```

--------------------------------

### Count Property Example

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.events.model/-latest-thread-unsigned-relation/count

An example of an open, overridable property named `count` initialized to 0. This snippet demonstrates basic property declaration and initialization in Kotlin, often used in data classes or abstract classes.

```kotlin
open override val count: Int? = 0
```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.registration/-stage/-dummy/index

APIs for retrieving and interpreting home server capabilities, including room version support and other features.

```APIDOC
## Home Server Capabilities API

### Description
Allows retrieval and interpretation of home server capabilities, such as supported room versions and other feature flags.

### HomeServerCapabilitiesService
Service for accessing home server capabilities.

- `HomeServerCapabilities`: Represents the capabilities of a home server.
  - `RoomCapabilitySupport`: Information about support for room capabilities.
    - `SUPPORTED`: The capability is supported.
    - `SUPPORTED_UNSTABLE`: The capability is supported as an unstable feature.
    - `UNSUPPORTED`: The capability is not supported.
    - `UNKNOWN`: The support status is unknown.

- `RoomVersionInfo`: Information about a specific room version.
- `RoomVersionStatus`: Status of a room version.
  - `STABLE`: The room version is stable.
  - `UNSTABLE`: The room version is unstable.
```

--------------------------------

### Crypto Initialization (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.accountdata/-user-account-data-event/index

Provides functionality to initialize and configure the cryptographic components of the SDK, including setting up logging for Rust-based crypto implementations.

```kotlin
// Assuming relevant imports and context

fun setRustLogger() {
    // Implementation to set the logger for Rust crypto components
    // ...
}
```

--------------------------------

### Get Decimal and Emoji Code Representations for Verification

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.failure/is-unrecognised-certificate

Functions to get human-readable decimal and emoji representations of verification codes. These are used in interactive verification flows to confirm device identity.

```kotlin
fun getDecimalCodeRepresentation(code: String): String {
    // Implementation details would go here
    return ""
}

fun getEmojiCodeRepresentation(code: String): List<String> {
    // Implementation details would go here
    return emptyList()
}
```

--------------------------------

### User Story: Initialize Matrix SDK

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.room.model/-room-name-content/index

Represents the user story for initializing the Matrix SDK. This is typically the first step in integrating the SDK.

```kotlin
org.matrix.android.sdk.userstories.Us000InitMatrix

```

--------------------------------

### GET /publicRooms

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.crypto/-m-x-c-r-y-p-t-o_-a-l-g-o-r-i-t-h-m_-o-l-m

Lists public rooms on the homeserver.

```APIDOC
## GET /publicRooms

### Description
Lists publicly accessible rooms, optionally filtered by parameters.

### Method
GET

### Endpoint
/publicRooms

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of rooms to return.
- **server** (string) - Optional - The server to query.
- **since** (string) - Optional -  A token to paginate results.

### Request Example
None

### Response
#### Success Response (200)
- **chunk** (array) - An array of room information.
- **next_batch** (string) -  Pagination token for the next batch.
- **prev_batch** (string) - Pagination token for the previous batch

#### Response Example
```json
{
  "chunk": [
    {
      "aliases": ["#room1:example.com"],
      "name": "Room One",
      "room_id": "!room1id:example.com",
      "topic": "Welcome to Room One",
      "num_joined_members": 5
    }
  ],
  "next_batch": "token_next",
  "prev_batch": "token_prev"
}
```
```

--------------------------------

### POST /register

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.crypto/-m-x-c-r-y-p-t-o_-a-l-g-o-r-i-t-h-m_-o-l-m

Registers a new user on the homeserver.

```APIDOC
## POST /register

### Description
Registers a new user, potentially with 3PID information.

### Method
POST

### Endpoint
/register

### Parameters
#### Request Body
- **username** (string) - Required - The desired username.
- **password** (string) - Required - The desired password.
- **auth** (object) - Optional - Authentication object (e.g., for 3PID validation)

### Request Example
```json
{
  "username": "newuser",
  "password": "P@sswOrd123",
  "auth": {
    "type": "m.login.email.identity",
    "session": "session_id",
    "token": "verification_token"
  }
}
```

### Response
#### Success Response (200)
- **user_id** (string) - The user's Matrix ID.
- **access_token** (string) - The access token for the new user.
- **home_server** (string) - The home server for the new user.
- **device_id** (string) - The device ID.

#### Response Example
```json
{
  "user_id": "@newuser:example.com",
  "access_token": "syt_abcdefg",
  "home_server": "example.com",
  "device_id": "DEVICEID"
}
```
```

--------------------------------

### GET /rooms/{roomId}/members

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.widgets/-widget-management-failure/-creation-failed/index

Retrieves the members of a room.

```APIDOC
## GET /rooms/{roomId}/members

### Description
Retrieves the members of a given room.

### Method
GET

### Endpoint
/rooms/{roomId}/members

### Parameters
#### Path Parameters
- **roomId** (string) - Required - The ID of the room.

#### Query Parameters
- **at** (string) - Optional - The point in time to return the list of members at.  If not provided, the current list is returned.

### Request Example
```
GET /rooms/!roomid:example.com/members
```

### Response
#### Success Response (200)
- **chunk** (array) - An array of member events.
    - **content** (object) - The event content.
        - **displayname** (string) - The user's display name.
        - **avatar_url** (string) - The user's avatar URL.
    - **state_key** (string) - The user ID.
    - **type** (string) - The event type.

#### Response Example
```json
{
  "chunk": [
    {
      "content": {
        "displayname": "John Doe",
        "avatar_url": "mxc://example.com/abcdefg"
      },
      "state_key": "@user:example.com",
      "type": "m.room.member"
    }
  ]
}
```
```

--------------------------------

### GET /publicRooms

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.widgets/-widget-management-failure/-creation-failed/index

Retrieves a list of public rooms on the homeserver.

```APIDOC
## GET /publicRooms

### Description
Lists public rooms available on the homeserver.

### Method
GET

### Endpoint
/publicRooms

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of rooms to return.
- **server** (string) - Optional - The server to search on.
- **filter** (object) - Optional - A filter to apply to the room list.

### Request Example
```
GET /publicRooms?limit=10
```

### Response
#### Success Response (200)
- **chunk** (array) - An array of room objects.
    - **room_id** (string) - The room ID.
    - **name** (string) - The room name.
    - **topic** (string) - The room topic.
    - **aliases** (array) - Aliases of the room.
    - **num_joined_members** (integer) - The number of joined members.
- **prev_batch** (string) -  Token to request the previous batch.
- **next_batch** (string) - Token to request the next batch.

#### Response Example
```json
{
  "chunk": [
    {
      "room_id": "!roomid:example.com",
      "name": "Room Name",
      "topic": "Room Topic",
      "aliases": ["#alias:example.com"],
      "num_joined_members": 5
    }
  ],
  "prev_batch": "token1",
  "next_batch": "token2"
}
```
```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.content/-content-url-resolver/-thumbnail-method/index

APIs for retrieving and managing home server capabilities and room versions.

```APIDOC
## Home Server Capabilities API

### Description
This section describes how to interact with home server capabilities and room version information using the Matrix SDK.

### Endpoints
N/A (This is a documentation of models and enums, not direct endpoints)

### Models and Enums

#### HomeServerCapabilities
Represents the capabilities of a Matrix home server.

#### RoomCapabilitySupport
Indicates the support level for a specific room capability.
- **SUPPORTED**: The capability is supported.
- **SUPPORTED_UNSTABLE**: The capability is supported as an unstable feature.
- **UNSUPPORTED**: The capability is not supported.
- **UNKNOWN**: The support status is unknown.

#### RoomVersionInfo
Information about a specific room version.

#### RoomVersionStatus
Status of a room version.
- **STABLE**: The room version is stable.
- **UNSTABLE**: The room version is unstable.
```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.pushrules.rest/-push-rule-and-kind/index

APIs for retrieving and understanding home server capabilities.

```APIDOC
## Home Server Capabilities API

### Description
Provides interfaces for accessing and interpreting home server capabilities, including room version support.

### Method
N/A (Documentation of Enums and Classes)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

#### Enumerations and Classes:
- **org.matrix.android.sdk.api.session.homeserver**: Package for home server related classes.
- **HomeServerCapabilities**: Represents the capabilities of a home server.
- **Companion**: Companion object.
- **RoomCapabilitySupport**: Enum indicating support level for room capabilities.
- **SUPPORTED**, **SUPPORTED_UNSTABLE**, **UNSUPPORTED**, **UNKNOWN**: Levels of room capability support.
- **HomeServerCapabilitiesService**: Service to retrieve home server capabilities.
- **RoomCapabilitySupport**: Enum for room capability support.
- **RoomVersionCapabilities**: Capabilities related to specific room versions.
- **RoomVersionInfo**: Information about a room version.
- **RoomVersionStatus**: Enum for the status of a room version.
- **STABLE**, **UNSTABLE**: Room version statuses.
```

--------------------------------

### GET /account

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.widgets/-widget-management-failure/-creation-failed/index

Retrieves the user's account information.

```APIDOC
## GET /account

### Description
Retrieves information about the currently logged-in user's account.

### Method
GET

### Endpoint
/account

### Parameters
None

### Request Example
(No request body)

### Response
#### Success Response (200)
- **displayname** (string) - The user's display name.
- **avatar_url** (string) - The user's avatar URL.

#### Response Example
```json
{
  "displayname": "John Doe",
  "avatar_url": "mxc://example.com/abcdefg"
}
```
```

--------------------------------

### Initialize Matrix SDK (User Story)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.crosssigning/is-cross-signed-verified

Represents the user story for initializing the Matrix SDK. This is the first step in integrating the SDK into an application.

```kotlin
object Us000InitMatrix

```

--------------------------------

### GET /versions

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.crypto/-m-x-c-r-y-p-t-o_-a-l-g-o-r-i-t-h-m_-o-l-m

Retrieves the server's supported versions.

```APIDOC
## GET /versions

### Description
This endpoint retrieves a list of versions of the specification the server supports.

### Method
GET

### Endpoint
/versions

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **versions** (array of strings) - Supported specification versions

#### Response Example
```json
{
  "versions": [
    "r0.0.1",
    "r0.1.0",
    "r0.2.0",
    "r0.3.0",
    "r0.4.0",
    "r0.5.0",
    "r1.0",
    "v1.1",
    "v1.2"
  ]
}
```
```

--------------------------------

### GET /account

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/-local-notification-settings-content/is-silenced

Retrieves information about the user's account.

```APIDOC
## GET /account

### Description
Retrieves information about the user's account, such as display name and avatar URL.

### Method
GET

### Endpoint
/account

### Parameters
None

### Request Example
(No request body needed)

### Response
#### Success Response (200)
- **displayname** (string) - The user's display name.
- **avatar_url** (string) - The URL of the user's avatar.

#### Response Example
```json
{
  "displayname": "My Name",
  "avatar_url": "mxc://matrix.org/some_image_id"
}
```
```

--------------------------------

### Realm Database Compaction on Launch (Kotlin)

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.room.model.roomdirectory/-public-rooms-params/index

Configures Realm database compaction to run when the application launches. Compaction optimizes database size and performance by removing unused space. This setting ensures the database is in a good state from the start.

```kotlin
/**
 * Realm database configuration for compaction on launch.
 */
object RealmCompactOnLaunch {
    const val ENABLED = true
    // Other configuration options can be added here.
}
```

--------------------------------

### GET /profile/{userId}

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.crypto/-m-x-c-r-y-p-t-o_-a-l-g-o-r-i-t-h-m_-o-l-m

Retrieves a user's profile information.

```APIDOC
## GET /profile/{userId}

### Description
Fetches the profile information for a given user ID.

### Method
GET

### Endpoint
/profile/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user's Matrix ID.

### Request Example
None

### Response
#### Success Response (200)
- **displayname** (string) - The user's display name.
- **avatar_url** (string) - The user's avatar URL.

#### Response Example
```json
{
  "displayname": "Existing User",
  "avatar_url": "mxc://example.com/some_image"
}
```
```

--------------------------------

### GET /publicRooms

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/-local-notification-settings-content/is-silenced

Retrieves a list of public rooms available on the homeserver.

```APIDOC
## GET /publicRooms

### Description
Retrieves a list of public rooms available on the homeserver.

### Method
GET

### Endpoint
/publicRooms

### Parameters
None

### Request Example
(No request body needed)

### Response
#### Success Response (200)
- **chunk** (array) - An array of room objects, each containing information about a public room.
  - **aliases** (array) - Aliases of the room.
  - **name** (string) - Room name.
  - **topic** (string) - Room topic.
  - **room_id** (string) - Room ID.
  - **num_joined_members** (integer) - Number of joined members.
  - **avatar_url** (string) - Room avatar URL.

#### Response Example
```json
{
  "chunk": [
    {
      "aliases": [
        "#roomalias:matrix.org"
      ],
      "name": "Room Name",
      "topic": "Room Topic",
      "room_id": "!roomid:matrix.org",
      "num_joined_members": 5,
      "avatar_url": "mxc://matrix.org/avatar_id"
    }
  ]
}
```
```

--------------------------------

### Create Room Parameters API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.verification/-e-verification-state/-waiting-for-ready/index

Defines parameters and presets for creating new Matrix rooms.

```APIDOC
## Create Room Parameters API

Defines parameters and presets for creating new Matrix rooms.

### Core Class

- **CreateRoomParams**: Contains all parameters for creating a room.

### Presets

- **CreateRoomPreset**: Enum for common room creation presets:
  - `PRESET_PRIVATE_CHAT`
  - `PRESET_PUBLIC_CHAT`
  - `PRESET_TRUSTED_PRIVATE_CHAT`

### Other Models

- **RoomCreateContent**: The content of the `m.room.create` event.
- **RestrictedRoomPreset**: Preset for creating restricted rooms.
- **RoomFeaturePreset**: Presets for room features.

### Packages

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

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.network/-api-path/-g-e-t_-m-e-d-i-a_-c-o-n-f-i-g/index

APIs for querying and understanding the capabilities supported by the Matrix homeserver.

```APIDOC
## Home Server Capabilities API

Allows the SDK to query and determine the features and capabilities supported by the connected homeserver.

### `HomeServerCapabilitiesService`

Service to fetch and access homeserver capabilities.

### `HomeServerCapabilities`

An object containing details about the homeserver's supported features.

#### `RoomCapabilitySupport`

Indicates the support level for room-specific features.

*   `SUPPORTED`
*   `SUPPORTED_UNSTABLE`
*   `UNSUPPORTED`
*   `UNKNOWN`

### Room Versions

*   `RoomVersionInfo`: Information about a specific room version.
*   `RoomVersionStatus`: The status of a room version (e.g., `STABLE`, `UNSTABLE`).
```

--------------------------------

### GET /profile/{userId}

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/-local-notification-settings-content/is-silenced

Retrieves the profile information of a specified user.

```APIDOC
## GET /profile/{userId}

### Description
Retrieves a user's profile information, including display name and avatar URL.

### Method
GET

### Endpoint
/profile/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user whose profile is requested.

### Request Example
(No request body needed)

### Response
#### Success Response (200)
- **displayname** (string) - The user's display name.
- **avatar_url** (string) - The URL of the user's avatar.

#### Response Example
```json
{
  "displayname": "Some User",
  "avatar_url": "mxc://matrix.org/image_id"
}
```
```

--------------------------------

### GET /profile/{userId}/displayname

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.widgets/-widget-management-failure/-creation-failed/index

Retrieves the display name of a given user.

```APIDOC
## GET /profile/{userId}/displayname

### Description
Fetches the display name associated with a user ID.

### Method
GET

### Endpoint
/profile/{userId}/displayname

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user ID to retrieve the display name for.

### Request Example
```
GET /profile/@user:example.com/displayname
```

### Response
#### Success Response (200)
- **displayname** (string) - The user's display name.

#### Response Example
```json
{
  "displayname": "John Doe"
}
```
```

--------------------------------

### HomeServer API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.permalinks/-matrix-permalink-span/-callback/index

APIs for querying homeserver capabilities and room version information.

```APIDOC
## HomeServer API

### Description
APIs for querying homeserver capabilities, including support for room versions and specific features.

### HomeServer Capabilities
- **HomeServerCapabilities**: Represents the capabilities of a homeserver.
- **Companion**: Companion object for `HomeServerCapabilities`.
- **RoomCapabilitySupport**: Represents the support status for room capabilities.
- **SUPPORTED**: Capability is supported.
- **SUPPORTED_UNSTABLE**: Unstable feature is supported.
- **UNSUPPORTED**: Capability is not supported.
- **UNKNOWN**: Capability status is unknown.

### HomeServer Capabilities Service
- **HomeServerCapabilitiesService**: Service for retrieving homeserver capabilities.

### Room Version Information
- **RoomVersionCapabilities**: Capabilities related to specific room versions.
- **RoomVersionInfo**: Information about a room version.
- **RoomVersionStatus**: Enum representing the status of a room version.
- **STABLE**: Room version is stable.
- **UNSTABLE**: Room version is unstable.
```

--------------------------------

### GET /logout

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/-local-notification-settings-content/is-silenced

This endpoint allows users to log out of their session, invalidating the access token.

```APIDOC
## GET /logout

### Description
Logs out the user, invalidating the current access token.

### Method
GET

### Endpoint
/logout

### Parameters
None

### Request Example
(No request body needed)

### Response
#### Success Response (200)
No response body

#### Response Example
(Empty response body)
```

--------------------------------

### Database Realm Compact on Launch

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.verification/-verification-event/index

The `RealmCompactOnLaunch` class handles the process of compacting the Realm database when the application launches. This is an optimization technique to reduce database file size and improve performance.

```kotlin
class RealmCompactOnLaunch(private val context: Context)
```

--------------------------------

### Matrix Initialization User Story

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.account/index

User story 'Us000InitMatrix' outlines the process of initializing a Matrix session. This is the first step for any client interacting with the Matrix service.

```kotlin
object Us000InitMatrix
```

--------------------------------

### Media and File Upload API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.query/-query-state-event-value/index

Endpoints for managing media, including getting media configuration and uploading files.

```APIDOC
## Media and File Upload API

### Description
This API group covers functionalities related to media handling, including retrieving media server configuration and uploading files.

### Endpoints

#### GET /_matrix/client/v3/media/config
**Description**: Retrieves the media configuration of the homeserver.
**Method**: GET
**Endpoint**: `/_matrix/client/v3/media/config`

#### POST /_matrix/media/v3/upload
**Description**: Uploads a file to the media repository.
**Method**: POST
**Endpoint**: `/_matrix/media/v3/upload`
**Query Parameters**:
- `content_type` (string) - Optional - The MIME type of the file.
- `filename` (string) - Optional - The name of the file.
**Request Body**:
- The raw content of the file to upload.

```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.room.model/-references-aggregated-summary/content

Retrieves and manages information about the capabilities supported by the homeserver.

```APIDOC
## Home Server Capabilities API

This API allows fetching information about the capabilities supported by the connected homeserver.

### Home Server Capabilities Service

Provides access to homeserver capabilities.

- **`HomeServerCapabilitiesService`**: Interface for retrieving homeserver capabilities.

### Home Server Capabilities

Represents the capabilities supported by a homeserver.

- **`HomeServerCapabilities`**: Holds information about supported features.
  - **`RoomCapabilitySupport`**: Indicates support for room-specific capabilities.
    - **`SUPPORTED`**: The capability is fully supported.
    - **`SUPPORTED_UNSTABLE`**: The capability is supported via an unstable feature.
    - **`UNSUPPORTED`**: The capability is not supported.
    - **`UNKNOWN`**: The support status is unknown.

### Room Version Capabilities

Details about room versions and their stability.

- **`RoomVersionInfo`**: Information about a specific room version.
- **`RoomVersionStatus`**: Indicates the status of a room version (STABLE, UNSTABLE).
```

--------------------------------

### Room Service API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.network/-api-path/-g-e-t_-a-l-i-a-s-e-s/index

Provides methods for managing rooms, including getting room summaries, timelines, and account data.

```APIDOC
## Room Service API

### Description
This API provides access to room-related services, including fetching room summaries, timeline events, and account data.

### Methods
- **RoomService**: Manages core room functionalities.
- **RoomSummaryQueryParams**: Defines parameters for querying room summaries.
- **RoomAccountDataService**: Handles room account data.
- **RoomAccountDataEvent**: Represents room account data events.
- **RoomAccountDataTypes**: Defines types for room account data.

### Endpoints
- `/room/summary`: Retrieve room summaries.
- `/room/accountdata`: Access room account data.

### Parameters
#### RoomSummaryQueryParams
- **name** (String) - Optional - Filter by room name.
- **activity** (Long) - Optional - Filter by room activity.
- **priorityAndActivity** (Long) - Optional - Filter by priority and activity.
- **none** (Void) - Optional - No specific filtering.

#### RoomAccountDataEvent
- **type** (String) - Required - The type of the account data event.
- **content** (JsonObject) - Required - The content of the account data event.

### Request Example
```json
{
  "name": "My Room",
  "activity": 1678886400000
}
```

### Response
#### Success Response (200)
- **List<RoomSummary>** - A list of room summaries matching the query.
- **JsonObject** - Room account data.

#### Response Example
```json
{
  "roomId": "!abc:matrix.org",
  "name": "General Discussion",
  "canonicalAlias": "#general:matrix.org"
}
```
```

--------------------------------

### Room Call Service API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.events.model/to-valid-decrypted-event

Manages real-time communication features within rooms, including call setup and signaling.

```APIDOC
## Room Call Service API

### Description
Provides APIs for managing real-time calls within Matrix rooms, including initiating, answering, and managing call states.

### Endpoints

#### RoomCallService
Service for handling room call functionalities.
```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.network/-api-path/-p-i-n-g/index

APIs for retrieving and understanding the capabilities of the homeserver.

```APIDOC
## Home Server Capabilities API

### Description
This section details the APIs for querying and interpreting the capabilities supported by the Matrix homeserver.

### Key Components:
- **HomeServerCapabilitiesService**: Service to access homeserver capabilities.
- **HomeServerCapabilities**: Data class holding the homeserver's supported features.
- **RoomCapabilitySupport**: Enum indicating the support level for room-specific capabilities.

### Classes and Enums:
- `org.matrix.android.sdk.api.session.homeserver`
- `HomeServerCapabilities`
- `Companion`
- `RoomCapabilitySupport`
- `SUPPORTED`
- `SUPPORTED_UNSTABLE`
- `UNSUPPORTED`
- `UNKNOWN`
- `HomeServerCapabilitiesService`
- `RoomCapabilitySupport`
- `RoomVersionCapabilities`
- `RoomVersionInfo`
- `RoomVersionStatus`
- `STABLE`
- `UNSTABLE`
```

--------------------------------

### Room Model - Create Room Parameters

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.pushers/-push-gateway-failure/index

Parameters and presets for creating a new room.

```APIDOC
## Room Model - Create Room Parameters

### Description
Defines parameters and presets for creating new Matrix rooms.

### Parameters

- **CreateRoomParams**: Main class for specifying parameters when creating a room.
  - **Companion**: Companion object for CreateRoomParams.

### Presets

- **CreateRoomPreset**: Enum for predefined room creation settings.
  - **PRESET_PRIVATE_CHAT**: Preset for creating a private chat room.
  - **PRESET_PUBLIC_CHAT**: Preset for creating a public chat room.
  - **PRESET_TRUSTED_PRIVATE_CHAT**: Preset for creating a trusted private chat room.

### Other Models

- **RoomCreateContent**: Content for the room create event.
- **Predecessor**: Information about a predecessor room, used for upgrades.
- **RestrictedRoomPreset**: Defines presets for restricted rooms.
- **RoomFeaturePreset**: Defines presets for room features.
```

--------------------------------

### Room Alias Service API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.events.model/-latest-thread-unsigned-relation/count

Manages room aliases, allowing users to create, get, and check the availability of room aliases.

```APIDOC
## Room Alias Service API

### Description
Manages room aliases, providing methods to create, retrieve, and check the availability of human-readable room aliases.

### Methods
- `getAliasForRoom(roomId: String)`: Gets the primary alias for a given room ID.
- `getRoomIdForAlias(alias: String)`: Gets the room ID for a given alias.
- `createAlias(roomId: String, alias: String)`: Creates a new alias for a room.
- `deleteAlias(alias: String)`: Deletes an alias.

### Data Models
- `RoomAliasDescription`: Describes a room alias.
- `AliasAvailabilityResult`: Indicates the availability of an alias (Available, NotAvailable).
- `RoomAliasError`: Represents errors related to room aliases (AliasInvalid, AliasIsBlank, AliasNotAvailable).
```

--------------------------------

### Compatibility Functions for Application Info

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.crosssigning/is-cross-signed-verified

Helper functions to get application info compatibly across different Android SDK versions.

```kotlin
fun getApplicationInfoCompat(context: Context, packageName: String): ApplicationInfo?
fun getPackageInfoCompat(context: Context, packageName: String, flags: Long): PackageInfo?

```

--------------------------------

### Home Server Capabilities API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.auth.data/-sso-identity-provider/-companion/-b-r-a-n-d_-f-a-c-e-b-o-o-k

APIs for querying and managing home server capabilities and room versions.

```APIDOC
## Home Server Capabilities Service (`org.matrix.android.sdk.api.session.homeserver`)

### Description
Allows querying and managing home server capabilities, including room version support.

### Endpoints

#### `org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilities`

##### Description
Represents the capabilities supported by a Matrix home server.

#### `org.matrix.android.sdk.api.session.homeserver.HomeServerCapabilitiesService`

##### Description
Service for retrieving home server capabilities.

#### `org.matrix.android.sdk.api.session.homeserver.RoomCapabilitySupport`

##### Description
Indicates the support level for specific room capabilities.

##### Enum Values
- `SUPPORTED`
- `SUPPORTED_UNSTABLE`
- `UNSUPPORTED`
- `UNKNOWN`

#### `org.matrix.android.sdk.api.session.homeserver.RoomVersionCapabilities`

##### Description
Capabilities related to different room versions.

#### `org.matrix.android.sdk.api.session.homeserver.RoomVersionInfo`

##### Description
Information about a specific room version.

#### `org.matrix.android.sdk.api.session.homeserver.RoomVersionStatus`

##### Description
Status of a room version.

##### Enum Values
- `STABLE`
- `UNSTABLE`
```

--------------------------------

### Room Management API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.network/-api-path/-d-e-l-e-t-e_-r-o-o-m_-s-e-s-s-i-o-n-s_-d-a-t-a/index

APIs for interacting with Matrix rooms, including sending messages, getting room members, and creating rooms.

```APIDOC
## Room Management API

### Description
This section details the APIs for managing and interacting with Matrix rooms. It covers functionalities such as sending messages, retrieving room state, managing members, and creating new rooms.

### Endpoints

#### `POST /_matrix/client/v3/rooms/{roomId}/send/{eventType}`

##### Description
Sends an event to a specific room.

##### Method
POST

##### Endpoint
`/_matrix/client/v3/rooms/{roomId}/send/{eventType}`

##### Parameters

###### Path Parameters
- **roomId** (string) - Required - The ID of the room to send the event to.
- **eventType** (string) - Required - The type of the event to send (e.g., `m.room.message`).

###### Query Parameters
- **access_token** (string) - Required - The user's access token.

###### Request Body
- **content** (object) - Required - The payload of the event.
- **txn_id** (string) - Optional - A client-generated transaction ID for deduplication.

##### Request Example
```json
{
  "content": {
    "msgtype": "m.text",
    "body": "Hello, world!"
  },
  "txn_id": "my_unique_txn_id"
}
```

#### `GET /_matrix/client/v3/rooms/{roomId}/messages`

##### Description
Retrieves messages from a specific room.

##### Method
GET

##### Endpoint
`/_matrix/client/v3/rooms/{roomId}/messages`

##### Parameters

###### Path Parameters
- **roomId** (string) - Required - The ID of the room to retrieve messages from.

###### Query Parameters
- **from** (string) - Required - The token to paginate from.
- **limit** (integer) - Optional - The maximum number of messages to return.
- **direction** (string) - Optional - The direction of pagination (`'b'` for backward, `'f'` for forward). Defaults to `'b'`.
- **filter** (object) - Optional - A filter to apply to the messages.

##### Response

###### Success Response (200)
- **chunk** (array) - A list of message events.
- **start** (string) - The token to paginate backward from.
- **end** (string) - The token to paginate forward from.

###### Response Example
```json
{
  "chunk": [
    {
      "event_id": "$someeventid",
      "sender": "@alice:matrix.org",
      "origin_server_ts": 1678886400000,
      "type": "m.room.message",
      "content": {
        "msgtype": "m.text",
        "body": "Hello, world!"
      }
    }
  ],
  "start": "t315-xyzabc",
  "end": "t315-defghi"
}
```

#### `GET /_matrix/client/v3/rooms/{roomId}/members`

##### Description
Retrieves the list of members in a room.

##### Method
GET

##### Endpoint
`/_matrix/client/v3/rooms/{roomId}/members`

##### Parameters

###### Path Parameters
- **roomId** (string) - Required - The ID of the room to retrieve members from.

###### Query Parameters
- **limit** (integer) - Optional - The maximum number of members to return.
- **since** (string) - Optional - A token to paginate the results.
- **membership** (string) - Optional - Filter by membership state (e.g., `join`, `leave`, `invite`).

##### Response

###### Success Response (200)
- **members** (array) - A list of room members.
  - **membership** (string) - The membership state.
  - **is_direct** (boolean) - Whether this is a direct message room.
  - **displayname** (string) - Optional - The display name of the member.
  - **avatar_url** (string) - Optional - The avatar URL of the member.
  - **user_id** (string) - The user ID of the member.
- **joined_once** (string) - Optional - Token for pagination.

###### Response Example
```json
{
  "members": [
    {
      "user_id": "@alice:matrix.org",
      "membership": "join",
      "displayname": "Alice",
      "avatar_url": "mxc://example.com/avatar.png",
      "is_direct": false
    }
  ]
}
```

#### `POST /_matrix/client/v3/createRoom`

##### Description
Creates a new Matrix room.

##### Method
POST

##### Endpoint
`/_matrix/client/v3/createRoom`

##### Parameters

###### Request Body
- **name** (string) - Optional - The name of the room.
- **topic** (string) - Optional - The topic of the room.
- **visibility** (string) - Optional - The visibility of the room (`public` or `private`).
- **room_alias** (string) - Optional - An alias for the room.
- **invite** (array) - Optional - A list of user IDs to invite to the room.
- **creation_content** (object) - Optional - Content for the `m.room.create` event.
- **initial_state** (array) - Optional - A list of initial state events for the room.
- **preset** (string) - Optional - A room preset (e.g., `public_chat`, `private_chat`).

##### Request Example
```json
{
  "name": "My New Room",
  "topic": "Discussing SDK features",
  "visibility": "private",
  "invite": ["@bob:matrix.org"]
}
```

##### Response

###### Success Response (200)
- **room_id** (string) - The ID of the newly created room.
- **room_alias** (string) - Optional - The alias of the newly created room.

###### Response Example
```json
{
  "room_id": "!newroomid:matrix.org",
  "room_alias": "#myroom:matrix.org"
}
```
```

--------------------------------

### Create Room API

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.content/-content-url-resolver/-thumbnail-method/index

APIs for creating new Matrix rooms, including parameters and presets.

```APIDOC
## Create Room API

### Description
Provides functionalities for creating new Matrix rooms with various configuration options.

### Endpoints

#### CreateRoomParams Class
Parameters for creating a room.

#### CreateRoomPreset Enum
Predefined presets for room creation.

- `PRESET_PRIVATE_CHAT`
- `PRESET_PUBLIC_CHAT`
- `PRESET_TRUSTED_PRIVATE_CHAT`

#### CreateRoomStateEvent Class
Represents a state event during room creation.

#### Predecessor Class
Information about a predecessor room.

#### RestrictedRoomPreset Enum
Presets for restricted rooms.

#### RoomCreateContent Class
Content for the room creation event.

#### RoomFeaturePreset Enum
Feature presets for rooms.
```

--------------------------------

### Room Creation and State

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.pushrules.rest/-push-rule-and-kind/index

APIs for creating rooms and managing their initial state.

```APIDOC
## Room Creation and State

This section outlines the APIs for creating new Matrix rooms and setting their initial state.

### CreateRoomService

Provides functionalities for creating new rooms.

#### Methods
- **createRoom(params: CreateRoomParams)**: Creates a new room with the specified parameters.

### CreateRoomParams

Parameters for creating a new room.

#### Fields:
- **name**: The name of the room.
- **isPublic**: Whether the room is public.
- **preset**: The creation preset (e.g., PRESET_PRIVATE_CHAT, PRESET_PUBLIC_CHAT).
- **topic**: The topic of the room.
- **initialState**: A list of initial state events to set.
- **invite**: A list of users to invite.
- **creation_content**: Additional content for the room creation event.

### CreateRoomPreset

Predefined configurations for creating rooms.

#### Presets:
- **PRESET_PRIVATE_CHAT**: For private, direct conversations.
- **PRESET_PUBLIC_CHAT**: For public, discoverable rooms.
- **PRESET_TRUSTED_PRIVATE_CHAT**: For private chats with trusted users.

### RoomCreateContent

Content for the `m.room.create` event.

#### Fields:
- **creator**: The ID of the user creating the room.
- **room_version**: The version of the room.
- **predecessor**: Information about a predecessor room if this is an upgrade.

### VersioningState

Indicates the versioning state of a room.

#### States:
- **NONE**: No versioning information.
- **UPGRADED_ROOM_NOT_JOINED**: The room has been upgraded but the user has not joined the new room.
- **UPGRADED_ROOM_JOINED**: The user has joined the upgraded room.

```

--------------------------------

### Crypto Logging Setup - Kotlin

Source: https://matrix-org.github.io/matrix-android-sdk2/matrix-sdk-android/org.matrix.android.sdk.api.session.pushrules.rest/-push-rule-and-kind/index

Configures the Rust logger for cryptographic operations. This allows for detailed logging of encryption and decryption processes.

```kotlin
fun setRustLogger()

object CryptoLogger {
    // Logging methods for crypto operations
}
```
Tokens:
Raw