Class AdminCommandWarningsEvent

Event emitted when the Data API returned a warning for an admin command.

See AdminCommandEvent for more information about all the common properties available on this event.

Hierarchy (view full)

Constructors

constructor

Properties

longRunning method methodName name params? path reqBody? warnings

Methods

_desc formatted formattedPrefix

Constructors

constructor

Properties

Readonly longRunning

longRunning: boolean

Whether the command is long-running or not, i.e. requires polling.

Readonly method

method: "GET" | "POST" | "DELETE"

The HTTP method for the request.

Readonly methodName

methodName: string

The method which invoked the request

Readonly name

name: string

The name of the event.

Optional Readonly params

params?: Record<string, any>

The query parameters, if any.

Readonly path

path: string

The path for the request, not including the Base URL.

Optional Readonly reqBody

reqBody?: Record<string, any>

The request body, if any.

Readonly warnings

warnings: DataAPIErrorDescriptor[]

The warnings that occurred.

Methods

Protected _desc

formatted

Static formattedPrefix

Settings

Member Visibility

Theme

On This Page

constructorlongRunningmethodmethodNamenameparamspathreqBodywarnings_descformattedformattedPrefix