FailureEvent
A NonInteractiveEvent that is sent when a user action results in a error, like an invalid email when sending a form.
graph LR
AbstractEvent["AbstractEvent<span class='requires_context_and_properties'><span class='requires_context'>requires:<br />ApplicationContext<br /></span><span class='properties'>location_stack: LocationStack<br />global_contexts: GlobalContexts<br />id: uuid<br />time: integer<br /></span></span>"] --> NonInteractiveEvent;
NonInteractiveEvent --> FailureEvent["FailureEvent<span class='properties'>message: string<br /></span>"];
class FailureEvent diagramActive
click AbstractEvent "/docs/taxonomy/events" "See details" _self
click NonInteractiveEvent "/docs/taxonomy/reference/events/NonInteractiveEvent" "See details" _self
Diagram: FailureEvent inheritance
Requires
None.
Properties
| type | description | |
|---|---|---|
| message | string | Failure message. |
Inherited Properties
| type | description | |
|---|---|---|
| location_stack | LocationStack | The LocationStack is an ordered list (a stack) containing a hierarchy of LocationContexts, which deterministically describes where in the UI of an application an Event took place. |
| global_contexts | GlobalContexts | GlobalContexts add global/general information about the state in which an Event happened, such as a user's identity and marketing information. They do not carry information related to where the Event originated (location), which instead is captured by the LocationStack. |
| id | uuid | Unique identifier for a specific instance of an event. |
| time | integer | Timestamp indicating when the event was generated. |
setting of properties
The tracker will automatically set all the properties. The message is an error code or short message captured from the occurring error. This is purely for descriptive purposes.