Interface PluginConnectionPropertyOption
Hierarchy
PluginConnectionPropertyOption
Properties
description
description: string
Defined in core/src/models/Property.ts:87
Optional displayName displayName: string
Defined in core/src/models/Property.ts:85
key
key: string
Defined in core/src/models/Property.ts:84
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 } [] >
Defined in core/src/models/Property.ts:89
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
argument: { app: App ; appGuid: string ; appOptions: SimpleAppOptions ; connection: any ; property: Property ; propertyGuid: string ; source: Source ; sourceGuid: string ; sourceMapping: SourceMapping ; sourceOptions: SimpleSourceOptions }
appGuid: string
connection: any
propertyGuid: string
sourceGuid: string
sourceMapping: SourceMapping
Returns Promise < { description?: string ; examples?: any [] ; key: string } [] >
required
required: boolean
Defined in core/src/models/Property.ts:86
type
type: string
Defined in core/src/models/Property.ts:88
Legend
Constructor Property Method Accessor
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)