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

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)

Constructors

MatrixConfiguration

constructor(applicationFlavor: String = "Default-application-flavor", cryptoConfig: MXCryptoConfig = MXCryptoConfig(), integrationUIUrl: String = "https://scalar.vector.im/", integrationRestUrl: String = "https://scalar.vector.im/api", 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" ), clientPermalinkBaseUrl: String? = null, proxy: Proxy? = null, connectionSpec: ConnectionSpec = ConnectionSpec.RESTRICTED_TLS, supportsCallTransfer: Boolean = false, matrixItemDisplayNameFallbackProvider: MatrixItemDisplayNameFallbackProvider? = null, roomDisplayNameFallbackProvider: RoomDisplayNameFallbackProvider, threadMessagesEnabledDefault: Boolean = true, networkInterceptors: List<Interceptor> = emptyList(), syncConfig: SyncConfig = SyncConfig(), metricPlugins: List<MetricPlugin> = emptyList(), cryptoAnalyticsPlugin: CryptoMetricPlugin? = null, customEventTypesProvider: CustomEventTypesProvider? = null)

Properties

applicationFlavor

val applicationFlavor: String

clientPermalinkBaseUrl

val clientPermalinkBaseUrl: String? = null

Optional base url to create client permalinks (eg. https://www.example.com/#/) instead of Matrix ones (matrix.to links). Do not forget to add the "#" which is required by the permalink parser.

connectionSpec

val connectionSpec: ConnectionSpec

TLS versions and cipher suites limitation for unauthenticated requests.

cryptoAnalyticsPlugin

val cryptoAnalyticsPlugin: CryptoMetricPlugin? = null

cryptoConfig

val cryptoConfig: MXCryptoConfig

customEventTypesProvider

val customEventTypesProvider: CustomEventTypesProvider? = null

CustomEventTypesProvider to provide custom event types to the sdk which should be processed with internal events.

integrationRestUrl

val integrationRestUrl: String

integrationUIUrl

val integrationUIUrl: String

integrationWidgetUrls

val integrationWidgetUrls: List<String>

matrixItemDisplayNameFallbackProvider

val matrixItemDisplayNameFallbackProvider: MatrixItemDisplayNameFallbackProvider? = null

MatrixItemDisplayNameFallbackProvider to provide default display name for MatrixItem. By default, the id will be used

metricPlugins

val metricPlugins: List<MetricPlugin>

Metrics plugin that can be used to capture metrics from matrix-sdk-android.

networkInterceptors

val networkInterceptors: List<Interceptor>

List of network interceptors, they will be added when building an OkHttp client.

proxy

val proxy: Proxy? = null

Optional proxy to connect to the matrix servers. You can create one using for instance Proxy(proxyType, InetSocketAddress.createUnresolved(hostname, port).

roomDisplayNameFallbackProvider

val roomDisplayNameFallbackProvider: RoomDisplayNameFallbackProvider

RoomDisplayNameFallbackProvider to provide default room display name.

supportsCallTransfer

val supportsCallTransfer: Boolean = false

True to advertise support for call transfers to other parties on Matrix calls.

syncConfig

val syncConfig: SyncConfig

Sync configuration.

threadMessagesEnabledDefault

val threadMessagesEnabledDefault: Boolean = true

Thread messages default enable/disabled value.