PluginConnectionScheduleOption

Metadata and methods to return the options a Schedule for this connection/app. Options is a method which will poll the source for available options to select (ie: names of tables or columns)

Hierarchy

PluginConnectionScheduleOption

Index

Properties

Methods

options

Properties

description

description: string

key

key: string

required

required: boolean

type

type: "list" | "text" | "textarea"

Methods

options

options(argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; properties: Property[]; source: Source; sourceId: string; sourceMapping: SimpleSourceOptions; sourceOptions: SimpleSourceOptions }): Promise<{ description?: string; examples?: any[]; key: string }[]>

- Defined in core/src/models/Schedule.ts:48
Parameters
- argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; properties: Property[]; source: Source; sourceId: string; sourceMapping: SimpleSourceOptions; sourceOptions: SimpleSourceOptions }
  - app: App
  - appId: string
  - appOptions: SimpleAppOptions
  - connection: any
  - properties: Property[]
  - source: Source
  - sourceId: string
  - sourceMapping: SimpleSourceOptions
  - sourceOptions: SimpleSourceOptions
Returns Promise<{ description?: string; examples?: any[]; key: string }[]>

Hierarchy

Index

Properties

Methods

Properties

description

key

required

type

Methods

options

Parameters

argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; properties: Property[]; source: Source; sourceId: string; sourceMapping: SimpleSourceOptions; sourceOptions: SimpleSourceOptions }

app: App

appId: string

appOptions: SimpleAppOptions

connection: any

properties: Property[]

source: Source

sourceId: string

sourceMapping: SimpleSourceOptions

sourceOptions: SimpleSourceOptions

Returns Promise<{ description?: string; examples?: any[]; key: string }[]>