matrix-sdk-android/org.matrix.android.sdk.api

Package org.matrix.android.sdk.api

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

Types

Matrix

class Matrix(context: Context, matrixConfiguration: MatrixConfiguration)

This is the main entry point to the matrix sdk.

MatrixCallback

interface MatrixCallback<in T>

Generic callback interface for asynchronously.

MatrixConfiguration

data class MatrixConfiguration( val applicationFlavor: String = "Default-application-flavor", val cryptoConfig: MXCryptoConfig = MXCryptoConfig(), val integrationUIUrl: String = "https://scalar.vector.im/", val integrationRestUrl: String = "https://scalar.vector.im/api", val integrationWidgetUrls: List<String> = listOf( "https://scalar.vector.im/_matrix/integrations/v1", "https://scalar.vector.im/api", "https://scalar-staging.vector.im/_matrix/integrations/v1", "https://scalar-staging.vector.im/api", "https://scalar-staging.riot.im/scalar/api" ), val clientPermalinkBaseUrl: String? = null, val proxy: Proxy? = null, val connectionSpec: ConnectionSpec = ConnectionSpec.RESTRICTED_TLS, val supportsCallTransfer: Boolean = false, val matrixItemDisplayNameFallbackProvider: MatrixItemDisplayNameFallbackProvider? = null, val roomDisplayNameFallbackProvider: RoomDisplayNameFallbackProvider, val threadMessagesEnabledDefault: Boolean = true, val networkInterceptors: List<Interceptor> = emptyList(), val syncConfig: SyncConfig = SyncConfig(), val metricPlugins: List<MetricPlugin> = emptyList(), val cryptoAnalyticsPlugin: CryptoMetricPlugin? = null, val customEventTypesProvider: CustomEventTypesProvider? = null)

MatrixConstants

object MatrixConstants

This object define some global constants regarding the Matrix specification.

MatrixCoroutineDispatchers

data class MatrixCoroutineDispatchers( val io: CoroutineDispatcher, val computation: CoroutineDispatcher, val main: CoroutineDispatcher, val crypto: CoroutineDispatcher, val dmVerif: CoroutineDispatcher)

MatrixPatterns

object MatrixPatterns

This class contains pattern to match the different Matrix ids Ref: https://matrix.org/docs/spec/appendices#identifier-grammar

MatrixUrls

object MatrixUrls

This class contains pattern to match Matrix Url, aka mxc urls.

NoOpMatrixCallback

class NoOpMatrixCallback<T> : MatrixCallback<T>

Basic no op implementation.

SyncConfig

data class SyncConfig(val longPollTimeout: Long, val syncFilterParams: SyncFilterParams = SyncFilterParams())