Registers the "oneShotTrigger" funnel trigger type, letting a funnel automation be configured to restrict another trigger to firing at most once per user. Supplies the id, display title and description shown when choosing a trigger in the funnel automation editor, and builds a blank OneShotFunnelTrigger instance for a developer to configure with the trigger it wraps.
Group: Journeys
Implements: FunnelTriggerType
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short description of what this trigger does, shown alongside its title in the funnel automation editor. |
| id | String | The type identifier for this trigger type, used to register it and to match it to OneShotFunnelTrigger instances. |
| title | String | Display title for this trigger type shown when a developer chooses a trigger in the funnel automation editor. |
Methods
getId()
Returns: String
The type identifier for this trigger type, used to register it and to match it to OneShotFunnelTrigger instances.
getTitle()
Returns: String
Display title for this trigger type shown when a developer chooses a trigger in the funnel automation editor.
getDescription()
Returns: String
Short description of what this trigger does, shown alongside its title in the funnel automation editor.
create(FormContext form)
Returns: FunnelTrigger
Builds a new, unconfigured OneShotFunnelTrigger with no wrapped trigger set. The submitted form is not used; the wrapped trigger and applyPerItem flag are set separately via the trigger's update method once created.
| Parameter | Description |
|---|---|
form | the submitted form data, not used by this trigger type |