Interface ConnectorType

A unit is a container of elements, it can not contain other units.

interface ConnectorType {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "ConnectorKit$ConnectorType";
    $UnitID?: string;
    connectorActions: ConnectorAction[];
    connectorName: string;
    connectorProperties: ConnectorProperty[];
    description: string;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    icon: string;
    iconDark: string;
    name: string;
    version: string;
    addConnectorAction(): Promise<ConnectorAction>;
    addConnectorProperty(): Promise<ConnectorProperty>;
    getConnectorAction(name: string): undefined | ConnectorAction;
    getConnectorProperty(name: string): undefined | ConnectorProperty;
}

Hierarchy (View Summary)

Document
- ConnectorType

Index

Properties

$CreationOptions? $ID $Type $UnitID? connectorActions connectorName connectorProperties description documentation excluded exportLevel icon iconDark name version

Methods

addConnectorAction addConnectorProperty getConnectorAction getConnectorProperty

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "ConnectorKit$ConnectorType"

The type of the element.

`Optional`$UnitID

$UnitID?: string

connectorActions

connectorActions: ConnectorAction[]

connectorName

connectorName: string

connectorProperties

connectorProperties: ConnectorProperty[]

description

description: string

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

icon

icon: string

iconDark

iconDark: string

name

name: string

version

version: string

Methods

addConnectorAction

addConnectorAction(): Promise<ConnectorAction>
Returns Promise<ConnectorAction>

addConnectorProperty

addConnectorProperty(): Promise<ConnectorProperty>
Returns Promise<ConnectorProperty>

getConnectorAction

getConnectorAction(name: string): undefined | ConnectorAction
Parameters
- name: string
Returns undefined | ConnectorAction

getConnectorProperty

getConnectorProperty(name: string): undefined | ConnectorProperty
Parameters
- name: string
Returns undefined | ConnectorProperty