Class ApiError

Hierarchy

Error
- ApiError

Index

Constructors

Properties

activityId appliedTimeout code description managerCode outcome status

Constructors

constructor

new ApiError(
    body: ApiErrorBody,
    meta: ApiMeta | null | undefined,
    status: number,
    details?: ApiErrorDetails,
): ApiError
Parameters
- body: ApiErrorBody
- meta: ApiMeta | null | undefined
- status: number
- Optionaldetails: ApiErrorDetails
Returns ApiError
Overrides Error.constructor
- Defined in errors.ts:107

Properties

`Readonly`activityId

activityId: string | undefined

`Readonly`appliedTimeout

appliedTimeout: number | undefined

Server timeout that was applied to the request, in seconds (X-Request-Timeout-Applied).

`Readonly`code

code: WebApiErrorCode

`Readonly`description

description: string | undefined

`Readonly`managerCode

managerCode: string | number | undefined

`Readonly`outcome

outcome: RequestOutcome | undefined

What happened to the request when it did not complete (X-Request-Outcome).

`Readonly`status

status: number