Companion

object Companion

Properties

Link copied to clipboard
const val LIMIT_TYPE_MAU: String
Link copied to clipboard
const val M_BAD_JSON: String

Request contained valid JSON, but it was malformed in some way, e.g. missing required keys, invalid values for keys.

Link copied to clipboard
const val M_BAD_PAGINATION: String

(Not documented yet).

Link copied to clipboard
const val M_BAD_STATE: String

The state change requested cannot be performed, such as attempting to unban a user who is not banned.

Link copied to clipboard
const val M_CANNOT_LEAVE_SERVER_NOTICE_ROOM: String

The user is unable to reject an invite to join the server notices room. See the Server Notices module for more information.

Link copied to clipboard
const val M_CAPTCHA_INVALID: String

The Captcha provided did not match what was expected.

Link copied to clipboard
const val M_CAPTCHA_NEEDED: String

A Captcha is required to complete the request.

Link copied to clipboard
const val M_CONSENT_NOT_GIVEN: String

(Not documented yet).

Link copied to clipboard
const val M_EXCLUSIVE: String

The resource being requested is reserved by an application service, or the application service making the request has not created the resource.

Link copied to clipboard
const val M_FORBIDDEN: String

Forbidden access, e.g. joining a room without permission, failed login.

Link copied to clipboard
const val M_GUEST_ACCESS_FORBIDDEN: String

The room or resource does not permit guests to access it.

Link copied to clipboard
const val M_INCOMPATIBLE_ROOM_VERSION: String

The client attempted to join a room that has a version the server does not support. Inspect the room_version property of the error response for the room's version.

Link copied to clipboard
const val M_INVALID_PARAM: String

A parameter that was specified has the wrong value. For example, the server expected an integer and instead received a string.

Link copied to clipboard
const val M_INVALID_PEPPER: String
Link copied to clipboard
const val M_INVALID_ROOM_STATE: String

Sent when the initial state given to the createRoom API is invalid.

Link copied to clipboard
const val M_INVALID_USERNAME: String

Encountered when trying to register a user ID which is not valid.

Link copied to clipboard
const val M_LIMIT_EXCEEDED: String

Too many requests have been sent in a short period of time. Wait a while then try again.

Link copied to clipboard
const val M_LOGIN_EMAIL_URL_NOT_YET: String

(Not documented yet).

Link copied to clipboard
const val M_MISSING_PARAM: String

A required parameter was missing from the request.

Link copied to clipboard
const val M_MISSING_TOKEN: String

No access token was specified for the request.

Link copied to clipboard
const val M_NOT_FOUND: String

No resource was found for this request.

Link copied to clipboard
const val M_NOT_JSON: String

Request did not contain valid JSON.

Link copied to clipboard
const val M_OLD_VERSION: String

(Not documented yet).

Link copied to clipboard
const val M_PASSWORD_IN_DICTIONARY: String

The password was found in a dictionary, and is not acceptable.

Link copied to clipboard
const val M_PASSWORD_NO_DIGIT: String

The password doesn't contain any digit but the server requires at least one.

Link copied to clipboard
const val M_PASSWORD_NO_LOWERCASE: String

The password doesn't contain any lowercase letter but the server requires at least one.

Link copied to clipboard
const val M_PASSWORD_NO_SYMBOL: String

The password doesn't contain any symbol but the server requires at least one.

Link copied to clipboard
const val M_PASSWORD_NO_UPPERCASE: String

The password doesn't contain any uppercase letter but the server requires at least one.

Link copied to clipboard
const val M_PASSWORD_TOO_SHORT: String

The provided password's length is shorter than the minimum length required by the server.

Link copied to clipboard
const val M_RESOURCE_LIMIT_EXCEEDED: String

The request cannot be completed because the homeserver has reached a resource limit imposed on it. For example, a homeserver held in a shared hosting environment may reach a resource limit if it starts using too much memory or disk space. The error MUST have an admin_contact field to provide the user receiving the error a place to reach out to. Typically, this error will appear on routes which attempt to modify state (eg: sending messages, account data, etc) and not routes which only read state (eg: /sync, get account data, etc).

Link copied to clipboard
const val M_ROOM_IN_USE: String

Sent when the room alias given to the createRoom API is already in use.

Link copied to clipboard
const val M_SERVER_NOT_TRUSTED: String

The client's request used a third party server, eg. identity server, that this server does not trust.

Link copied to clipboard
const val M_TERMS_NOT_SIGNED: String
Link copied to clipboard
const val M_THREEPID_AUTH_FAILED: String

Authentication could not be performed on the third party identifier.

Link copied to clipboard
const val M_THREEPID_DENIED: String

The server does not permit this third party identifier. This may happen if the server only permits, for example, email addresses from a particular domain.

Link copied to clipboard
const val M_THREEPID_IN_USE: String

Sent when a threepid given to an API cannot be used because the same threepid is already in use.

Link copied to clipboard
const val M_THREEPID_NOT_FOUND: String

Sent when a threepid given to an API cannot be used because no record matching the threepid was found.

Link copied to clipboard
const val M_TOO_LARGE: String

The request or entity was too large.

Link copied to clipboard
const val M_UNAUTHORIZED: String

The request was not correctly authorized. Usually due to login failures.

Link copied to clipboard
const val M_UNKNOWN: String

An unknown error has occurred.

Link copied to clipboard
const val M_UNKNOWN_TOKEN: String

The access token specified was not recognised.

Link copied to clipboard
const val M_UNRECOGNIZED: String

The server did not understand the request.

Link copied to clipboard
const val M_UNSUPPORTED_ROOM_VERSION: String

The client's request to create a room used a room version that the server does not support.

Link copied to clipboard
const val M_USER_DEACTIVATED: String

The user ID associated with the request has been deactivated. Typically for endpoints that prove authentication, such as /login.

Link copied to clipboard
const val M_USER_IN_USE: String

Encountered when trying to register a user ID which has been taken.

Link copied to clipboard
const val M_WEAK_PASSWORD: String

(Not documented yet).

Link copied to clipboard
const val M_WRONG_ROOM_KEYS_VERSION: String

(Not documented yet).

Link copied to clipboard
const val ORG_MATRIX_EXPIRED_ACCOUNT: String

The user account has expired. It has to be renewed by clicking on an email or by sending a renewal token.