trixnity-core/net.folivo.trixnity.core/ErrorResponse

ErrorResponse

@Serializable

interface ErrorResponse

Types

BadJson

@Serializable

data class BadJson(val error: String? = null) : ErrorResponse

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

BadState

@Serializable

data class BadState(val error: String? = null) : ErrorResponse

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

CannotLeaveServerNoticeRoom

@Serializable

data class CannotLeaveServerNoticeRoom(val error: String? = null) : ErrorResponse

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

CaptchaInvalid

@Serializable

data class CaptchaInvalid(val error: String? = null) : ErrorResponse

The Captcha provided did not match what was expected.

CaptchaNeeded

@Serializable

data class CaptchaNeeded(val error: String? = null) : ErrorResponse

A Captcha is required to complete the request.

CustomErrorResponse

@Serializable

data class CustomErrorResponse(val errorCode: String, val error: String? = null) : ErrorResponse

All ErrorResponses, that we cannot map to a subtype of ErrorResponse.

Exclusive

@Serializable

data class Exclusive(val error: String? = null) : ErrorResponse

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

Forbidden

@Serializable

data class Forbidden(val error: String? = null) : ErrorResponse

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

GuestAccessForbidden

@Serializable

data class GuestAccessForbidden(val error: String? = null) : ErrorResponse

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

IncompatibleRoomVersion

@Serializable

data class IncompatibleRoomVersion(val error: String? = null, val roomVersion: String? = null) : ErrorResponse

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.

InvalidParam

@Serializable

data class InvalidParam(val error: String? = null) : ErrorResponse

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

InvalidRoomState

@Serializable

data class InvalidRoomState(val error: String? = null) : ErrorResponse

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

InvalidUsername

@Serializable

data class InvalidUsername(val error: String? = null) : ErrorResponse

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

LimitExceeded

@Serializable

data class LimitExceeded(val error: String? = null, val retryAfterMillis: Long) : ErrorResponse

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

MissingParam

@Serializable

data class MissingParam(val error: String? = null) : ErrorResponse

A required parameter was missing from the request.

MissingToken

@Serializable

data class MissingToken(val error: String? = null) : ErrorResponse

No access token was specified for the request.

NotFound

@Serializable

data class NotFound(val error: String? = null) : ErrorResponse

No resource was found for this request.

NotJson

@Serializable

data class NotJson(val error: String? = null) : ErrorResponse

Request did not contain valid JSON.

ResourceLimitExceeded

@Serializable

data class ResourceLimitExceeded(val error: String? = null, val adminContact: String? = null) : ErrorResponse

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.

RoomInUse

@Serializable

data class RoomInUse(val error: String? = null) : ErrorResponse

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

ServerNotTrusted

@Serializable

data class ServerNotTrusted(val error: String? = null) : ErrorResponse

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

ThirdPIdAuthFailed

@Serializable

data class ThirdPIdAuthFailed(val error: String? = null) : ErrorResponse

Authentication could not be performed on the third party identifier.

ThirdPIdDenied

@Serializable

data class ThirdPIdDenied(val error: String? = null) : ErrorResponse

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.

ThirdPIdInUse

@Serializable

data class ThirdPIdInUse(val error: String? = null) : ErrorResponse

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

ThirdPIdNotFound

@Serializable

data class ThirdPIdNotFound(val error: String? = null) : ErrorResponse

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

TooLarge

@Serializable

data class TooLarge(val error: String? = null) : ErrorResponse

The request or entity was too large.