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

Matrix

class Matrix(context: Context, matrixConfiguration: MatrixConfiguration)
Content copied to clipboard

This is the main entry point to the matrix sdk.

The constructor creates a new instance of Matrix, it's recommended to manage this instance as a singleton.

Parameters

context

the application context

matrixConfiguration

global configuration that will be used for every org.matrix.android.sdk.api.session.Session

Constructors

Link copied to clipboard
fun Matrix(context: Context, matrixConfiguration: MatrixConfiguration)
Content copied to clipboard

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
fun authenticationService(): AuthenticationService
Content copied to clipboard

Return the AuthenticationService.

Link copied to clipboard
fun debugService(): DebugService
Content copied to clipboard

Return the DebugService.

Link copied to clipboard
fun getUserAgent(): String
Content copied to clipboard

Return the User Agent used for any request that the SDK is making to the homeserver. There is no way to change the user agent at the moment.

Link copied to clipboard
fun getWorkerFactory(): WorkerFactory
Content copied to clipboard

Get the worker factory. The returned value has to be provided to WorkConfiguration.Builder().

Link copied to clipboard
fun homeServerHistoryService(): HomeServerHistoryService
Content copied to clipboard

Return the HomeServerHistoryService.

Link copied to clipboard
fun lightweightSettingsStorage(): LightweightSettingsStorage
Content copied to clipboard

Return the LightweightSettingsStorage.

Link copied to clipboard
fun rawService(): RawService
Content copied to clipboard

Return the RawService.

Link copied to clipboard
fun registerApiInterceptorListener(path: ApiPath, listener: ApiInterceptorListener)
Content copied to clipboard

Register an API interceptor, to be able to be notified when the specified API got a response.

Link copied to clipboard
fun secureStorageService(): SecureStorageService
Content copied to clipboard

Returns the SecureStorageService used to encrypt and decrypt sensitive data.

Link copied to clipboard
fun unregisterApiInterceptorListener(path: ApiPath, listener: ApiInterceptorListener)
Content copied to clipboard

Un-register an API interceptor.