Interface EngineAccess.Data.FlowTrigger
-
- Enclosing interface:
- EngineAccess.Data
public static interface EngineAccess.Data.FlowTrigger
The data of a flow trigger.- Since:
- 1.3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDescription()
Returns the description text of this flow trigger.String
getId()
Returns the ID of this flow trigger.Map<String,String>
getMetadata()
Returns the metadata of this flow trigger.String
getName()
Returns the name of this flow trigger.int
getOrder()
If this is a syntax or class trigger then its sub-order value (relative to the order group) is returned.String
getOrderGroup()
If this is a syntax trigger then the name of its order group is returned.String
getTriggerType()
Returns the type of this trigger.String
toString()
Returns a human readable representation of this flow trigger.
-
-
-
Method Detail
-
getId
String getId()
Returns the ID of this flow trigger.- Since:
- 1.3.0
-
getName
String getName()
Returns the name of this flow trigger.- Since:
- 1.3.0
-
getDescription
String getDescription()
Returns the description text of this flow trigger.- Since:
- 1.3.0
-
getTriggerType
String getTriggerType()
Returns the type of this trigger. Possible values areintent-trigger
andprompt-trigger
.- Since:
- 5.1.0
-
getOrderGroup
String getOrderGroup()
If this is a syntax trigger then the name of its order group is returned.For all other trigger types
null
is returned.- Since:
- 1.3.0
-
getOrder
int getOrder()
If this is a syntax or class trigger then its sub-order value (relative to the order group) is returned.If this is a prompt trigger then its order value (relative to all prompt triggers) is returned.
- Since:
- 1.3.0
-
getMetadata
Map<String,String> getMetadata()
Returns the metadata of this flow trigger.- Returns:
- an unmodifiable
Map
containing the metadata name/value pairs - Since:
- 1.3.0
-
-