Class Query

A query used by an app. This can take the form of an external action, a data transformation, or a state variable change.

Hierarchy

  • Query

Constructors

constructor

Properties

additionalProperties? events? id name properties? type

Constructors

constructor

Properties

Optional additionalProperties

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

Optional events

events?: AppBuilderEvent[]

Events to listen for downstream of the query.

id

id: string

The ID of the query.

name

name: string

The name of the query. The name must be unique within the app and is visible in the app editor.

Optional properties

properties?: any

The properties of the query. The properties vary depending on the query type.

type

type: QueryType

The query type.

Settings

Member Visibility

Theme

Generated using TypeDoc