Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PluginConnectionPropertyOption

Metadata and methods to return the options a Property 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

  • PluginConnectionPropertyOption

Index

Properties

description

description: string

Optional displayName

displayName: string

key

key: string

options

options: (argument: { app: App; appGuid: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyGuid: string; source: Source; sourceGuid: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }) => Promise<{ description?: string; examples?: any[]; key: string }[]>

Type declaration

    • (argument: { app: App; appGuid: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyGuid: string; source: Source; sourceGuid: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }): Promise<{ description?: string; examples?: any[]; key: string }[]>
    • Parameters

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

required

required: boolean

type

type: string

Generated using TypeDoc