Connectors can be connected to control types in Touch Portal such as sliders. A connector works the same way as most other elements such as the action. A user will be able to add the connector to a Slider control and from that moment the slider will send data from that connector and the slider value to the plug-in.
| Key | Type | Req. | API | Description |
|---|---|---|---|---|
| id | Text | yes | 4.0 | This is the id of the connector. It is used to identify the connectors within Touch Portal. This id needs to be unique across plugins. This means that if you give it the id "1" there is a big chance that it will be a duplicate. Touch Portal may reject it or mix it up with a different plug-in. Best practise is to create a unique prefix for all your actions like in our case; tp_yourplugin_connector_001. |
| name | Text | yes | 4.0 | This is the name of the connector. This will be used as the connector name in the connector category list. |
| format | Text | yes | 4.0 | This will be the format of the inline connector. Use the id's of the
data objects to place them within the text. Example given: "format":"Control {$connectordata001$} which has {$connectordata002$} and number {$connectordata003$} is {$connectordata004$}", This is a fictive form but it shows how to use this. The data object with the id 'connectordata001' will be shown at the given location. To have an data object appear on the connector line, use the format {$id$} where id is the id of the data object you want to show the control for. |
| data | Array | No | 4.0 | This is a collection of data which can be specified by the user. These data id's can be used to fill up the format attribute. |
| subCategoryId | Text | No | 7.0 | This attribute allows you to connect this connector to a specified sub category id. This action will then be shown in Touch Portals Action selection list attached to that sub category instead of the main parent category. |
This shows a JSON of a connector.