Interface IApiResponseMessage

An API response message.

interface IApiResponseMessage {
    code: Nullable<number>;
    id: Nullable<string>;
    internal: boolean;
    message: string;
    type: ApiResponseMessageType;
}

Properties

code id internal message type

Properties

code

code: Nullable<number>

A human-readble error code.

id

id: Nullable<string>

The unique ID of an entry in a database, e.g.

internal

internal: boolean

Indicates if it an internal message or a message, which can be read be an user.

message

message: string

The message text.

type

type: ApiResponseMessageType

The type. Default: 'info'

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc