EventType enum

Events emitted by the SDK during the form lifecycle.

Inheritance
Available extensions

Values

formShow → const EventType

Fired when a form is shown.

formStarted → const EventType

Fired when the user starts interacting with a form.

formSubmit → const EventType

Fired when a form is submitted.

formComplete → const EventType

Fired when a form is fully completed.

formClose → const EventType

Fired when a form is closed.

formDismissed → const EventType

Fired when a form is dismissed without completion.

formError → const EventType

Fired when an error occurs in the form.

formSectionChange → const EventType

Fired when the visible form section changes.

formAnswered → const EventType

Fired when a question is answered.

formRemindMeLater → const EventType

Fired when the user taps "Remind me later" in a form.

formCtaTriggered → const EventType

Fired when a completionCta action triggers on a thank_you or exit_form screen.

EventPayload.data contains:

  • action: 'app_navigate' | 'redirect_internal' | 'redirect_external'
  • route (app_navigate only): the host route to navigate to
  • url (redirect_* only): the URL that was opened
  • surface: always 'inApp'
  • trigger: 'manual' | 'auto'

For app_navigate the host should navigate to data['route'] in an Encatch.on listener; the SDK closes the form overlay automatically after emitting this event (same UX as redirect/dismiss CTAs). For redirect actions the SDK opens the URL and the form closes automatically.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<EventType>
A constant List of the values in this enum, in order of their declaration.