Class MatrixSafetyError

This error is thrown when the homeserver refuses to handle an action due to a safety concern.

See

https://github.com/matrix-org/matrix-spec-proposals/pull/4387

Hierarchy (View Summary)

MatrixError
- MatrixSafetyError

Index

Constructors

Properties

data errcode? error? event? expiry? harms httpHeaders? httpStatus? url?

Methods

asWidgetApiErrorData getRetryAfterMs isRateLimitError fromWidgetApiErrorData

Constructors

constructor

new MatrixSafetyError(
    ...props: [
        errorJson: IErrorJson,
        httpStatus?: number,
        url?: string,
        event?: MatrixEvent,
        httpHeaders?: Headers,
    ],
): MatrixSafetyError
Parameters
- ...props: [
      errorJson: IErrorJson,
      httpStatus?: number,
      url?: string,
      event?: MatrixEvent,
      httpHeaders?: Headers,
  ]
Returns MatrixSafetyError
Overrides MatrixError.constructor
- Defined in src/http-api/errors.ts:251

Properties

data

data: IErrorJson

`Optional` `Readonly`errcode

errcode?: string

`Optional` `Readonly`error

error?: string

`Optional`event

event?: MatrixEvent

`Optional` `Readonly`expiry

expiry?: Date

The date at which a request can be reattempted.

`Readonly`harms

harms: Set<string>

The kinds of harms detected by the server.

See

https://github.com/matrix-org/matrix-spec-proposals/pull/4387 for a list of spec defined harms.

`Optional` `Readonly`httpHeaders

httpHeaders?: Headers

`Optional` `Readonly`httpStatus

httpStatus?: number

`Optional`url

url?: string

Methods

asWidgetApiErrorData

asWidgetApiErrorData(): IMatrixApiError
Returns IMatrixApiError
this error expressed as a JSON payload for use by Widget API error responses.
Inherited from MatrixError.asWidgetApiErrorData
- Defined in src/http-api/errors.ts:145

getRetryAfterMs

getRetryAfterMs(): number | null
Returns number | null
The recommended delay in milliseconds to wait before retrying the request that triggered this error, or null if no delay is recommended.

Throws
Error if the recommended delay is an invalid value.

See
safeGetRetryAfterMs for a version of this check that doesn't throw.
Inherited from MatrixError.getRetryAfterMs
- Defined in src/http-api/errors.ts:126

isRateLimitError

isRateLimitError(): boolean
Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).

If this returns true, getRetryAfterMs can be called to retrieve the server-side recommendation for the retry period.

Returns boolean
Whether this error is due to rate-limiting.
Inherited from MatrixError.isRateLimitError
- Defined in src/http-api/errors.ts:119

`Static`fromWidgetApiErrorData

fromWidgetApiErrorData(data: IMatrixApiError): MatrixError
Parameters
- data: IMatrixApiError
Returns MatrixError
a new MatrixError from a JSON payload received from Widget API error responses.
Inherited from MatrixError.fromWidgetApiErrorData
- Defined in src/http-api/errors.ts:168