Companion

object Companion

Properties

Link copied to clipboard
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

(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

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

The Captcha provided did not match what was expected.

Link copied to clipboard

A Captcha is required to complete the request.

Link copied to clipboard

(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

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

Link copied to clipboard

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

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
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

(Not documented yet).

Link copied to clipboard

A required parameter was missing from the request.

Link copied to clipboard

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

(Not documented yet).

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Authentication could not be performed on the third party identifier.

Link copied to clipboard

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

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

Link copied to clipboard

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

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

The access token specified was not recognised.

Link copied to clipboard

The server did not understand the request.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

(Not documented yet).

Link copied to clipboard

(Not documented yet).

Link copied to clipboard

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