Carries the data for one firing of a repository app automation trigger, ready to be matched against configured triggers and used to build notification emails. Built by a repository app when it wants to raise a named trigger (for example a form submission or a webhook), and passed through the trigger engine to any matching TriggerTypeMapping. The up to five trigger items are positional condition values supplied by the app and made available to the trigger's format function; attributes and attachments carry additional data used when rendering the resulting email.
Implements: TriggerEvent
Properties
| Property | Returns | Description |
|---|---|---|
| attachments | List<EmailAttachmentBean> | Email attachments to include if this trigger results in a notification email being sent. |
| attributes | Map<String,Object> | Additional named attributes attached to this trigger event, used to supply extra data to the trigger's format function. |
| eventId | String | Identifier of the trigger type this event fires, used to match it against a registered TriggerTypeMapping. |
| serialisable | boolean | Whether the app which fired this event declared its attributes safe to serialise, ie it used EventWrapper.eventBuilder(true) and the attribute values were checked when they were added. Nothing infers this: an event says yes only because the app that built it said so. Agents subscribe on the strength of it, because a buffered event is written to storage and read back long after the firing transaction has gone. |
| sourceProfile | Profile | Profile that caused this trigger to fire, if known. |
| triggerItem1 | String | First positional condition value supplied when the trigger was raised. |
| triggerItem2 | String | Second positional condition value supplied when the trigger was raised. |
| triggerItem3 | String | Third positional condition value supplied when the trigger was raised. |
| triggerItem4 | String | Fourth positional condition value supplied when the trigger was raised. |
| triggerItem5 | String | Fifth positional condition value supplied when the trigger was raised. |
| website | Website | Website the trigger fired within, if any. |
Methods
getEventId() · getWebsite() · getSourceProfile() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes() · isSerialisable() · getAttachments()
getEventId()
Returns: String
Identifier of the trigger type this event fires, used to match it against a registered TriggerTypeMapping.
getWebsite()
Returns: Website
Website the trigger fired within, if any.
getSourceProfile()
Returns: Profile
Profile that caused this trigger to fire, if known.
getTriggerItem1()
Returns: String
First positional condition value supplied when the trigger was raised.
getTriggerItem2()
Returns: String
Second positional condition value supplied when the trigger was raised.
getTriggerItem3()
Returns: String
Third positional condition value supplied when the trigger was raised.
getTriggerItem4()
Returns: String
Fourth positional condition value supplied when the trigger was raised.
getTriggerItem5()
Returns: String
Fifth positional condition value supplied when the trigger was raised.
getAttributes()
Returns: Map<String,Object>
Additional named attributes attached to this trigger event, used to supply extra data to the trigger's format function.
isSerialisable()
Returns: boolean
Whether the app which fired this event declared its attributes safe to serialise, ie it used EventWrapper.eventBuilder(true) and the attribute values were checked when they were added. Nothing infers this: an event says yes only because the app that built it said so. Agents subscribe on the strength of it, because a buffered event is written to storage and read back long after the firing transaction has gone.
getAttachments()
Returns: List<EmailAttachmentBean>
Email attachments to include if this trigger results in a notification email being sent.