matrix-sdk-android/org.matrix.android.sdk.api.session.homeserver/HomeServerCapabilities

HomeServerCapabilities

data class HomeServerCapabilities( val canChangePassword: Boolean = true, val canChangeDisplayName: Boolean = true, val canChangeAvatar: Boolean = true, val canChange3pid: Boolean = true, val maxUploadFileSize: Long = MAX_UPLOAD_FILE_SIZE_UNKNOWN, val lastVersionIdentityServerSupported: Boolean = false, val defaultIdentityServerUrl: String? = null, val roomVersions: RoomVersionCapabilities? = null, val canUseThreading: Boolean = false, val canControlLogoutDevices: Boolean = false, val canLoginWithQrCode: Boolean = false, val canUseThreadReadReceiptsAndNotifications: Boolean = false, val canRemotelyTogglePushNotificationsOfDevices: Boolean = false, var canRedactRelatedEvents: Boolean = false, val externalAccountManagementUrl: String? = null, val authenticationIssuer: String? = null, val disableNetworkConstraint: Boolean? = null)

Constructors

fun HomeServerCapabilities( canChangePassword: Boolean = true, canChangeDisplayName: Boolean = true, canChangeAvatar: Boolean = true, canChange3pid: Boolean = true, maxUploadFileSize: Long = MAX_UPLOAD_FILE_SIZE_UNKNOWN, lastVersionIdentityServerSupported: Boolean = false, defaultIdentityServerUrl: String? = null, roomVersions: RoomVersionCapabilities? = null, canUseThreading: Boolean = false, canControlLogoutDevices: Boolean = false, canLoginWithQrCode: Boolean = false, canUseThreadReadReceiptsAndNotifications: Boolean = false, canRemotelyTogglePushNotificationsOfDevices: Boolean = false, canRedactRelatedEvents: Boolean = false, externalAccountManagementUrl: String? = null, authenticationIssuer: String? = null, disableNetworkConstraint: Boolean? = null)

Types

Companion

object Companion

RoomCapabilitySupport

enum RoomCapabilitySupport : Enum<HomeServerCapabilities.RoomCapabilitySupport>

Functions

isFeatureSupported

fun isFeatureSupported(feature: String): HomeServerCapabilities.RoomCapabilitySupport

Check if a feature is supported by the homeserver.

fun isFeatureSupported(feature: String, byRoomVersion: String): Boolean

versionOverrideForFeature

fun versionOverrideForFeature(feature: String): String?

Use this method to know if you should force a version when creating a room that requires this feature. You can also use #isFeatureSupported prior to this call to check if the feature is supported and report some feedback to user.

Properties

authenticationIssuer

val authenticationIssuer: String? = null

Authentication issuer for use with MSC3824 delegated OIDC, provided in Wellknown.

canChange3pid

val canChange3pid: Boolean = true

True if it is possible to change the 3pid associations of the account.

canChangeAvatar

val canChangeAvatar: Boolean = true

True if it is possible to change the avatar of the account.

canChangeDisplayName

val canChangeDisplayName: Boolean = true

True if it is possible to change the display name of the account.

canChangePassword

val canChangePassword: Boolean = true

True if it is possible to change the password of the account.

canControlLogoutDevices

val canControlLogoutDevices: Boolean = false

True if the home server supports controlling the logout of all devices when changing password.

canLoginWithQrCode

val canLoginWithQrCode: Boolean = false

True if the home server supports login via qr code, false otherwise.

canRedactRelatedEvents

var canRedactRelatedEvents: Boolean = false

True if the home server supports redaction of related events.

canRemotelyTogglePushNotificationsOfDevices

val canRemotelyTogglePushNotificationsOfDevices: Boolean = false

True if the home server supports remote toggle of Pusher for a given device.

canUseThreading

val canUseThreading: Boolean = false

True if the home server support threading.

canUseThreadReadReceiptsAndNotifications

val canUseThreadReadReceiptsAndNotifications: Boolean = false

True if the home server supports threaded read receipts and unread notifications.

defaultIdentityServerUrl

val defaultIdentityServerUrl: String? = null

Default identity server url, provided in Wellknown.

delegatedOidcAuthEnabled

val delegatedOidcAuthEnabled: Boolean

disableNetworkConstraint

val disableNetworkConstraint: Boolean? = null

If set to true, the SDK will not use the network constraint when configuring Worker for the WorkManager, provided in Wellknown.

externalAccountManagementUrl

val externalAccountManagementUrl: String? = null

External account management url for use with MSC3824 delegated OIDC, provided in Wellknown.

lastVersionIdentityServerSupported

val lastVersionIdentityServerSupported: Boolean = false

Last version identity server and binding supported.

maxUploadFileSize

val maxUploadFileSize: Long

Max size of file which can be uploaded to the homeserver in bytes. MAX_UPLOAD_FILE_SIZE_UNKNOWN if unknown or not retrieved yet.

roomVersions

val roomVersions: RoomVersionCapabilities? = null

Room versions supported by the server. This capability describes the default and available room versions a server supports, and at what level of stability. Clients should make use of this capability to determine if users need to be encouraged to upgrade their rooms.