java.lang.Object
- io.github.ma1uta.matrix.ErrorResponse.Code

Enclosing class:: ErrorResponse

public static class ErrorResponse.Code
extends Object

Standard error codes.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`M_BAD_JSON`	Request contained valid JSON, but it was malformed in some way, e.g. missing required keys, invalid values for keys.
`static String`	`M_BAD_PAGINATION`	Encountered when specifying bad pagination query parameters.
`static String`	`M_BAD_STATE`	The state change requested cannot be performed, such as attempting to unban a user who is not banned.
`static String`	`M_CANNOT_LEAVE_SERVER_NOTICE_ROOM`	The user is unable to reject an invite to join the server notices room.
`static String`	`M_CAPTCHA_INVALID`	The Captcha provided did not match what was expected.
`static String`	`M_CAPTCHA_NEEDED`	A Captcha is required to complete the request.
`static String`	`M_EMAIL_SEND_ERROR`	There was an error sending an email.
`static String`	`M_EXCLUSIVE`	The resource being requested is reserved by an application service, or the application service making the request has not created the resource.
`static String`	`M_FORBIDDEN`	Forbidden access, e.g. joining a room without permission, failed login.
`static String`	`M_GUEST_ACCESS_FORBIDDEN`	The room or resource does not permit guests to access it.
`static String`	`M_INCOMPATIBLE_ROOM_VERSION`	The client attempted to join a room that has a version the server does not support.
`static String`	`M_INVALID_ADDRESS`	The provided third party address was not valid.
`static String`	`M_INVALID_EMAIL`	The email address provided was not valid.
`static String`	`M_INVALID_PARAM`	The request contained one or more invalid parameters.
`static String`	`M_INVALID_PASSWORD`	Encountered when trying to register a user ID which is not valid.
`static String`	`M_INVALID_ROOM_STATE`	Sent when the initial state given to the createRoom API is invalid.
`static String`	`M_INVALID_USERNAME`	Encountered when trying to register a user ID which is not valid.
`static String`	`M_LIMIT_EXCEEDED`	Too many requests have been sent in a short period of time.
`static String`	`M_MISSING_PARAM`	A required parameter was missing from the request.
`static String`	`M_MISSING_PARAMS`	The request was missing one or more parameters.
`static String`	`M_MISSING_TOKEN`	The access token specified was missing.
`static String`	`M_NO_VALID_SESSION`	A session could not be located for the given parameters.
`static String`	`M_NOT_FOUND`	No resource was found for this request.
`static String`	`M_NOT_JSON`	Request did not contain valid JSON.
`static String`	`M_RESOURCE_LIMIT_EXCEEDED`	The request cannot be completed because the homeserver has reached a resource limit imposed on it.
`static String`	`M_ROOM_IN_USE`	Sent when the room alias given to the createRoom API is already in use.
`static String`	`M_SEND_ERROR`	There was an error sending a notification.
`static String`	`M_SERVER_NOT_TRUSTED`	The client's request used a third party server, eg.
`static String`	`M_SESSION_EXPIRED`	The session has expired and must be renewed.
`static String`	`M_SESSION_NOT_VALIDATED`	The session of the identity server not found or not validated.
`static String`	`M_THREEPID_AUTH_FAILED`	Authentication could not be performed on the third party identifier.
`static String`	`M_THREEPID_DENIED`	The server does not permit this third party identifier.
`static String`	`M_THREEPID_IN_USE`	Sent when a threepid given to an API cannot be used because the same threepid is already in use.
`static String`	`M_THREEPID_NOT_FOUND`	Sent when a threepid given to an API cannot be used because no record matching the threepid was found.
`static String`	`M_TOO_LARGE`	The request or entity was too large.
`static String`	`M_UNAUTHORIZED`	The request was not correctly authorized.
`static String`	`M_UNKNOWN`	An unknown error has occurred.
`static String`	`M_UNKNOWN_TOKEN`	The access token specified was not recognised.
`static String`	`M_UNRECOGNIZED`	The request contained an unrecognised value, such as an unknown token or medium.
`static String`	`M_UNSUPPORTED_ROOM_VERSION`	The client's request to create a room used a room version that the server does not support.
`static String`	`M_USER_IN_USE`	Encountered when trying to register a user ID which has been taken.
`static String`	`M_WEAK_PASSWORD`	Clients SHOULD enforce that the password provided is suitably complex.

Constructor Summary

Constructors
Modifier Constructor Description

protected Code()

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - M_FORBIDDEN
```
public static final String M_FORBIDDEN
```
    Forbidden access, e.g. joining a room without permission, failed login.
    
    See Also:
    
    Constant Field Values
  - M_UNKNOWN_TOKEN
```
public static final String M_UNKNOWN_TOKEN
```
    The access token specified was not recognised.
    
    See Also:
    
    Constant Field Values
  - M_MISSING_TOKEN
```
public static final String M_MISSING_TOKEN
```
    The access token specified was missing.
    
    See Also:
    
    Constant Field Values
  - M_BAD_JSON
```
public static final String M_BAD_JSON
```
    Request contained valid JSON, but it was malformed in some way, e.g. missing required keys, invalid values for keys.
    
    See Also:
    
    Constant Field Values
  - M_NOT_JSON
```
public static final String M_NOT_JSON
```
    Request did not contain valid JSON.
    
    See Also:
    
    Constant Field Values
  - M_NOT_FOUND
```
public static final String M_NOT_FOUND
```
    No resource was found for this request.
    
    See Also:
    
    Constant Field Values
  - M_LIMIT_EXCEEDED
```
public static final String M_LIMIT_EXCEEDED
```
    Too many requests have been sent in a short period of time. Wait a while then try again.
    
    See Also:
    
    Constant Field Values
  - M_UNKNOWN
```
public static final String M_UNKNOWN
```
    An unknown error has occurred.
    
    See Also:
    
    Constant Field Values
  - M_UNRECOGNIZED
```
public static final String M_UNRECOGNIZED
```
    The request contained an unrecognised value, such as an unknown token or medium.
    
    See Also:
    
    Constant Field Values
  - M_UNAUTHORIZED
```
public static final String M_UNAUTHORIZED
```
    The request was not correctly authorized. Usually due to login failures.
    
    See Also:
    
    Constant Field Values
  - M_USER_IN_USE
```
public static final String M_USER_IN_USE
```
    Encountered when trying to register a user ID which has been taken.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_USERNAME
```
public static final String M_INVALID_USERNAME
```
    Encountered when trying to register a user ID which is not valid.
    
    See Also:
    
    Constant Field Values
  - M_ROOM_IN_USE
```
public static final String M_ROOM_IN_USE
```
    Sent when the room alias given to the createRoom API is already in use.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_ROOM_STATE
```
public static final String M_INVALID_ROOM_STATE
```
    Sent when the initial state given to the createRoom API is invalid.
    
    See Also:
    
    Constant Field Values
  - M_THREEPID_IN_USE
```
public static final String M_THREEPID_IN_USE
```
    Sent when a threepid given to an API cannot be used because the same threepid is already in use.
    
    See Also:
    
    Constant Field Values
  - M_THREEPID_NOT_FOUND
```
public static final String M_THREEPID_NOT_FOUND
```
    Sent when a threepid given to an API cannot be used because no record matching the threepid was found.
    
    See Also:
    
    Constant Field Values
  - M_THREEPID_AUTH_FAILED
```
public static final String M_THREEPID_AUTH_FAILED
```
    Authentication could not be performed on the third party identifier.
    
    See Also:
    
    Constant Field Values
  - M_THREEPID_DENIED
```
public static final String M_THREEPID_DENIED
```
    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.
    
    See Also:
    
    Constant Field Values
  - M_SERVER_NOT_TRUSTED
```
public static final String M_SERVER_NOT_TRUSTED
```
    The client's request used a third party server, eg. ID server, that this server does not trust.
    
    See Also:
    
    Constant Field Values
  - M_UNSUPPORTED_ROOM_VERSION
```
public static final String M_UNSUPPORTED_ROOM_VERSION
```
    The client's request to create a room used a room version that the server does not support.
    
    See Also:
    
    Constant Field Values
  - M_INCOMPATIBLE_ROOM_VERSION
```
public static final String M_INCOMPATIBLE_ROOM_VERSION
```
    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.
    
    See Also:
    
    Constant Field Values
  - M_BAD_STATE
```
public static final String M_BAD_STATE
```
    The state change requested cannot be performed, such as attempting to unban a user who is not banned.
    
    See Also:
    
    Constant Field Values
  - M_GUEST_ACCESS_FORBIDDEN
```
public static final String M_GUEST_ACCESS_FORBIDDEN
```
    The room or resource does not permit guests to access it.
    
    See Also:
    
    Constant Field Values
  - M_CAPTCHA_NEEDED
```
public static final String M_CAPTCHA_NEEDED
```
    A Captcha is required to complete the request.
    
    See Also:
    
    Constant Field Values
  - M_CAPTCHA_INVALID
```
public static final String M_CAPTCHA_INVALID
```
    The Captcha provided did not match what was expected.
    
    See Also:
    
    Constant Field Values
  - M_MISSING_PARAM
```
public static final String M_MISSING_PARAM
```
    A required parameter was missing from the request.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_PARAM
```
public static final String M_INVALID_PARAM
```
    The request contained one or more invalid parameters.
    
    See Also:
    
    Constant Field Values
  - M_TOO_LARGE
```
public static final String M_TOO_LARGE
```
    The request or entity was too large.
    
    See Also:
    
    Constant Field Values
  - M_EXCLUSIVE
```
public static final String M_EXCLUSIVE
```
    The resource being requested is reserved by an application service, or the application service making the request has not created the resource.
    
    See Also:
    
    Constant Field Values
  - M_RESOURCE_LIMIT_EXCEEDED
```
public static final String M_RESOURCE_LIMIT_EXCEEDED
```
    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).
    
    See Also:
    
    Constant Field Values
  - M_CANNOT_LEAVE_SERVER_NOTICE_ROOM
```
public static final String M_CANNOT_LEAVE_SERVER_NOTICE_ROOM
```
    The user is unable to reject an invite to join the server notices room. See the Server Notices module for more information.
    
    See Also:
    
    Constant Field Values
  - M_WEAK_PASSWORD
```
public static final String M_WEAK_PASSWORD
```
    Clients SHOULD enforce that the password provided is suitably complex. The password SHOULD include a lower-case letter, an upper-case letter, a number and a symbol and be at a minimum 8 characters in length.
    
    See Also:
    
    Constant Field Values
  - M_MISSING_PARAMS
```
public static final String M_MISSING_PARAMS
```
    The request was missing one or more parameters.
    
    See Also:
    
    Constant Field Values
  - M_SESSION_NOT_VALIDATED
```
public static final String M_SESSION_NOT_VALIDATED
```
    The session of the identity server not found or not validated.
    
    See Also:
    
    Constant Field Values
  - M_NO_VALID_SESSION
```
public static final String M_NO_VALID_SESSION
```
    A session could not be located for the given parameters.
    
    See Also:
    
    Constant Field Values
  - M_SESSION_EXPIRED
```
public static final String M_SESSION_EXPIRED
```
    The session has expired and must be renewed.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_EMAIL
```
public static final String M_INVALID_EMAIL
```
    The email address provided was not valid.
    
    See Also:
    
    Constant Field Values
  - M_EMAIL_SEND_ERROR
```
public static final String M_EMAIL_SEND_ERROR
```
    There was an error sending an email. Typically seen when attempting to verify ownership of a given email address.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_ADDRESS
```
public static final String M_INVALID_ADDRESS
```
    The provided third party address was not valid.
    
    See Also:
    
    Constant Field Values
  - M_SEND_ERROR
```
public static final String M_SEND_ERROR
```
    There was an error sending a notification. Typically seen when attempting to verify ownership of a given third party address.
    
    See Also:
    
    Constant Field Values
  - M_INVALID_PASSWORD
```
public static final String M_INVALID_PASSWORD
```
    Encountered when trying to register a user ID which is not valid.
    
    See Also:
    
    Constant Field Values
  - M_BAD_PAGINATION
```
public static final String M_BAD_PAGINATION
```
    Encountered when specifying bad pagination query parameters.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Code
```
protected Code()
```

Class ErrorResponse.Code

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

M_FORBIDDEN

M_UNKNOWN_TOKEN

M_MISSING_TOKEN

M_BAD_JSON

M_NOT_JSON

M_NOT_FOUND

M_LIMIT_EXCEEDED

M_UNKNOWN

M_UNRECOGNIZED

M_UNAUTHORIZED

M_USER_IN_USE

M_INVALID_USERNAME

M_ROOM_IN_USE

M_INVALID_ROOM_STATE

M_THREEPID_IN_USE

M_THREEPID_NOT_FOUND

M_THREEPID_AUTH_FAILED

M_THREEPID_DENIED

M_SERVER_NOT_TRUSTED

M_UNSUPPORTED_ROOM_VERSION

M_INCOMPATIBLE_ROOM_VERSION

M_BAD_STATE

M_GUEST_ACCESS_FORBIDDEN

M_CAPTCHA_NEEDED

M_CAPTCHA_INVALID

M_MISSING_PARAM

M_INVALID_PARAM

M_TOO_LARGE

M_EXCLUSIVE

M_RESOURCE_LIMIT_EXCEEDED

M_CANNOT_LEAVE_SERVER_NOTICE_ROOM

M_WEAK_PASSWORD

M_MISSING_PARAMS

M_SESSION_NOT_VALIDATED

M_NO_VALID_SESSION

M_SESSION_EXPIRED

M_INVALID_EMAIL

M_EMAIL_SEND_ERROR

M_INVALID_ADDRESS

M_SEND_ERROR

M_INVALID_PASSWORD

M_BAD_PAGINATION

Constructor Detail

Code