The properties of the action query.

Hierarchy

  • ActionQueryProperties

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.

The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.

mockedOutputs?: ActionQueryMockedOutputs

The mocked outputs of the action query. This is useful for testing the app without actually running the action.

onlyTriggerManually?: ActionQueryOnlyTriggerManually

Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.

outputs?: string

The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.

pollingIntervalInMs?: ActionQueryPollingIntervalInMs

If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.

requiresConfirmation?: ActionQueryRequiresConfirmation

Whether to prompt the user to confirm this query before it runs.

showToastOnError?: ActionQueryShowToastOnError

Whether to display a toast to the user when the query returns an error.

The definition of the action query.

Generated using TypeDoc