MatrixError

@JsonClass(generateAdapter = true)
data class MatrixError(@Json(name = "errcode") val code: String, @Json(name = "error") val message: String, @Json(name = "consent_uri") val consentUri: String? = null, @Json(name = "limit_type") val limitType: String? = null, @Json(name = "admin_contact") val adminUri: String? = null, @Json(name = "retry_after_ms") val retryAfterMillis: Long? = null, @Json(name = "soft_logout") val isSoftLogout: Boolean? = null, @Json(name = "lookup_pepper") val newLookupPepper: String? = null, @Json(name = "session") val session: String? = null, @Json(name = "completed") val completedStages: List<String>? = null, @Json(name = "flows") val flows: List<InteractiveAuthenticationFlow>? = null, @Json(name = "params") val params: JsonDict? = null)

This data class holds the error defined by the matrix specifications. You shouldn't have to instantiate it. Ref: https://matrix.org/docs/spec/client_server/latest#api-standards

Constructors

Link copied to clipboard
constructor(@Json(name = "errcode") code: String, @Json(name = "error") message: String, @Json(name = "consent_uri") consentUri: String? = null, @Json(name = "limit_type") limitType: String? = null, @Json(name = "admin_contact") adminUri: String? = null, @Json(name = "retry_after_ms") retryAfterMillis: Long? = null, @Json(name = "soft_logout") isSoftLogout: Boolean? = null, @Json(name = "lookup_pepper") newLookupPepper: String? = null, @Json(name = "session") session: String? = null, @Json(name = "completed") completedStages: List<String>? = null, @Json(name = "flows") flows: List<InteractiveAuthenticationFlow>? = null, @Json(name = "params") params: JsonDict? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val adminUri: String? = null
Link copied to clipboard

unique string which can be used to handle an error message.

Link copied to clipboard
Link copied to clipboard
val consentUri: String? = null
Link copied to clipboard
Link copied to clipboard
val isSoftLogout: Boolean? = null
Link copied to clipboard
val limitType: String? = null
Link copied to clipboard

human-readable error message.

Link copied to clipboard
val newLookupPepper: String? = null
Link copied to clipboard
val params: JsonDict? = null
Link copied to clipboard
val retryAfterMillis: Long? = null
Link copied to clipboard
val session: String? = null