Class XmlError

Error returned by the QuickBase XML API.

XML-API: This class is a legacy alias for QuickbaseXmlError.

Hierarchy (View Summary)

QuickbaseXmlError
- XmlError

Index

Constructors

constructor

new XmlError(
    code: number,
    text: string,
    detail?: string,
    action?: string,
): XmlError
Parameters
- code: number
- text: string
- Optionaldetail: string
- Optionalaction: string
Returns XmlError
Overrides QuickbaseXmlError.constructor
- Defined in src/xml/errors.ts:51

Properties

`Optional` `Readonly`action

action?: string

`Readonly`code

code: number

`Optional` `Readonly`description

description?: string

`Optional` `Readonly`rayId

rayId?: string

`Readonly`statusCode

statusCode: number

`Readonly`text

text: string

Methods

toJSON

toJSON(): {
    action: string
    | undefined;
    code: number;
    description: string | undefined;
    message: string;
    name: string;
    rayId: string | undefined;
    statusCode: number;
    text: string;
}
Returns {
    action: string | undefined;
    code: number;
    description: string | undefined;
    message: string;
    name: string;
    rayId: string | undefined;
    statusCode: number;
    text: string;
}
Inherited from QuickbaseXmlError.toJSON
- Defined in src/core/errors.ts:230

Class XmlError

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns XmlError

Properties

`Optional` `Readonly`action

`Readonly`code

`Optional` `Readonly`description

`Optional` `Readonly`rayId

`Readonly`statusCode

`Readonly`text

Methods

toJSON

Returns {
    action: string | undefined;
    code: number;
    description: string | undefined;
    message: string;
    name: string;
    rayId: string | undefined;
    statusCode: number;
    text: string;
}

Settings

On This Page

Class XmlError

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns XmlError

Properties

Optional Readonlyaction

Readonlycode

Optional Readonlydescription

Optional ReadonlyrayId

ReadonlystatusCode

Readonlytext

Methods

toJSON

Returns { action: string | undefined; code: number; description: string | undefined; message: string; name: string; rayId: string | undefined; statusCode: number; text: string;}

Settings

On This Page

`Optional` `Readonly`action

`Readonly`code

`Optional` `Readonly`description

`Optional` `Readonly`rayId

`Readonly`statusCode

`Readonly`text

Returns {
action: string | undefined;
code: number;
description: string | undefined;
message: string;
name: string;
rayId: string | undefined;
statusCode: number;
text: string;
}