Re-exports§
Modules§
Structs§
- Action
- Actions are one of the core components of Touch Portal. As a plug-in developer you can define
actions for your plug-in that the user can add to their flow of actions in their buttons and
events. An action is part of a [
Category]. - Action
Builder - Builder for
Action. - Bound
Data - Bound
Data Builder - Builder for
BoundData. - Category
- A category in your plugin will be an action category in Touch Portal.
- Category
Builder - Builder for
Category. - Choice
Data - Choice
Data Builder - Builder for
ChoiceData. - Choice
Setting - Choice
Setting Builder - Builder for
ChoiceSetting. - Choice
State - Choice
State Builder - Builder for
ChoiceState. - Color
Data - Color
Data Builder - Builder for
ColorData. - Connector
- Connectors can be connected to controls in Touch Portal such as Sliders and Dials.
- Connector
Builder - Builder for
Connector. - Data
- As a plug-in developer you can augment your actions with additional data that the user has to fill in.
- Data
Builder - Builder for
Data. - Event
- In Touch Portal there are events which will be triggered when a certain state changes.
- Event
Builder - Builder for
Event. - Event
Choice Value - Event
Choice Value Builder - Builder for
EventChoiceValue. - Event
Text Configuration - Event
Text Configuration Builder - Builder for
EventTextConfiguration. - File
Data - File
Data Builder - Builder for
FileData. - File
Setting - File
Setting Builder - Builder for
FileSetting. - Folder
Data - Folder
Data Builder - Builder for
FolderData. - Folder
Setting - Folder
Setting Builder - Builder for
FolderSetting. - I18n
Names - Language specific version of a name.
- I18n
Names Builder - Builder for
I18nNames. - Line
- Line
Builder - Builder for
Line. - Lines
- The lines object consist of the parts; the action lines and the onhold lines.
- Lines
Builder - Builder for
Lines. - Lingual
Line - Lingual
Line Builder - Builder for
LingualLine. - Local
State - The local states object represents the representation and visualisation within Touch Portal.
- Local
State Builder - Builder for
LocalState. - Multiline
Setting - Multiline
Setting Builder - Builder for
MultilineSetting. - Number
Data - Number
Data Builder - Builder for
NumberData. - Number
Setting - Number
Setting Builder - Builder for
NumberSetting. - Plugin
Configuration - Plugin
Configuration Builder - Builder for
PluginConfiguration. - Plugin
Description - Plugin
Description Builder - Builder for
PluginDescription. - Setting
- Setting
Builder - Builder for
Setting. - State
- In Touch Portal the user can use States which can be used by IF statement and with Events for example but can also be used in button texts or most actions.
- State
Builder - Builder for
State. - Static
Action - Static
Action Builder - Builder for
StaticAction. - SubCategory
- Plugin Categories can have sub categories which will be used to add structure to your list of actions, events and connectors.
- SubCategory
Builder - Builder for
SubCategory. - Suggestions
- This is a suggestions object where you can specify certain rendering behaviours of the action lines.
- Suggestions
Builder - Builder for
Suggestions. - Switch
Data - Switch
Data Builder - Builder for
SwitchData. - Switch
Setting - Switch
Setting Builder - Builder for
SwitchSetting. - Text
Data - Text
Data Builder - Builder for
TextData. - Text
Setting - Text
Setting Builder - Builder for
TextSetting. - Text
State - Text
State Builder - Builder for
TextState. - Tooltip
- Tooltip
Builder - Builder for
Tooltip.
Enums§
- Action
Builder Error - Error type for ActionBuilder
- Action
Implementation - ApiVersion
- Mapping from TouchPortal version to API version.
- Bound
Data Builder Error - Error type for BoundDataBuilder
- Category
Builder Error - Error type for CategoryBuilder
- Choice
Data Builder Error - Error type for ChoiceDataBuilder
- Choice
Setting Builder Error - Error type for ChoiceSettingBuilder
- Choice
State Builder Error - Error type for ChoiceStateBuilder
- Color
Data Builder Error - Error type for ColorDataBuilder
- Compare
Method - Connector
Builder Error - Error type for ConnectorBuilder
- Connector
Type - Data
Builder Error - Error type for DataBuilder
- Data
Format - Event
Builder Error - Error type for EventBuilder
- Event
Choice Value Builder Error - Error type for EventChoiceValueBuilder
- Event
Text Configuration Builder Error - Error type for EventTextConfigurationBuilder
- Event
Value Type - Execution
Type - File
Data Builder Error - Error type for FileDataBuilder
- File
Setting Builder Error - Error type for FileSettingBuilder
- Folder
Data Builder Error - Error type for FolderDataBuilder
- Folder
Setting Builder Error - Error type for FolderSettingBuilder
- I18n
Names Builder Error - Error type for I18nNamesBuilder
- Line
Builder Error - Error type for LineBuilder
- Lines
Builder Error - Error type for LinesBuilder
- Lingual
Line Builder Error - Error type for LingualLineBuilder
- Local
State Builder Error - Error type for LocalStateBuilder
- Multiline
Setting Builder Error - Error type for MultilineSettingBuilder
- Number
Data Builder Error - Error type for NumberDataBuilder
- Number
Setting Builder Error - Error type for NumberSettingBuilder
- Plugin
Category - You can add your plug-in in specific categories within Touch Portal.
- Plugin
Configuration Builder Error - Error type for PluginConfigurationBuilder
- Plugin
Description Builder Error - Error type for PluginDescriptionBuilder
- Setting
Builder Error - Error type for SettingBuilder
- Setting
Type - State
Builder Error - Error type for StateBuilder
- State
Type - Static
Action Builder Error - Error type for StaticActionBuilder
- SubCategory
Builder Error - Error type for SubCategoryBuilder
- Suggestions
Builder Error - Error type for SuggestionsBuilder
- Switch
Data Builder Error - Error type for SwitchDataBuilder
- Switch
Setting Builder Error - Error type for SwitchSettingBuilder
- Text
Data Builder Error - Error type for TextDataBuilder
- Text
Setting Builder Error - Error type for TextSettingBuilder
- Text
State Builder Error - Error type for TextStateBuilder
- Tooltip
Builder Error - Error type for TooltipBuilder