Class AjaxErrorResponse

A response that can be sent back to the H5P client when something went wrong.

Implements

Constructors

constructor

Properties

details? errorCode httpStatusCode message success

Constructors

constructor

  • new AjaxErrorResponse(
        errorCode: string,
        httpStatusCode: number,
        message: string,
        details?: string,
    ): AjaxErrorResponse

    Parameters

    • errorCode: string

      an error code that can be understood by the H5P client

    • httpStatusCode: number

      the HTTP status code

    • message: string

      The message displayed to the user. Should be localized if possible.

    • Optionaldetails: string

      (optional) Further text displayed to the user. Should be localized if possible.

    Returns AjaxErrorResponse

Properties

Optionaldetails

details?: string

(optional) Further text displayed to the user. Should be localized if possible.

errorCode

errorCode: string

an error code that can be understood by the H5P client

httpStatusCode

httpStatusCode: number

the HTTP status code

message

message: string

The message displayed to the user. Should be localized if possible.

success

success: boolean = false

True if the request was successful, false if something went wrong (errorCode and message should be filled in then).

Settings

Member Visibility

On This Page

Constructors
Properties