Represents one registered repository app automation trigger, holding the trigger's identifier, its user-facing description, the format function used to render notification text, and its configurable options. Instances are constructed by TriggerTypeBuilder.build() and kept in ControllerMappingList so the automation page can offer this trigger to a user and the platform can match it against a RepositoryAppTriggerEvent when the app raises one.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable description of this trigger, shown to a user configuring it on the automation page. |
| eventId | String | Identifier of this trigger, matched against RepositoryAppTriggerEvent.getEventId() when the app raises an event. |
| format | Object | The function invoked to render the notification text for this trigger, called with the page and the event's up to five trigger items. |
| options | LinkedHashSet<TriggerOptionMapping> | The named configuration options offered for this trigger on the automation configuration page, in the order they were added. |
Methods
getEventId()
Returns: String
Identifier of this trigger, matched against RepositoryAppTriggerEvent.getEventId() when the app raises an event.
getDescription()
Returns: String
Human-readable description of this trigger, shown to a user configuring it on the automation page.
getFormat()
Returns: Object
The function invoked to render the notification text for this trigger, called with the page and the event's up to five trigger items.
getOptions()
Returns: LinkedHashSet<TriggerOptionMapping>
The named configuration options offered for this trigger on the automation configuration page, in the order they were added.