Event class

The Event class represents an Algolia Insights event, which is used for collecting user interaction data in order to provide analytics and improve search relevance.

Constructors

Event.clickFilters(String eventName, String indexName, String userToken, String attribute, Iterable<String> values, {DateTime? timestamp})

Creates a click event with filter attribute and values.

Event.clickHits(String eventName, String indexName, String userToken, Iterable<String> objectIDs, {DateTime? timestamp})

Creates a click event with object IDs.

Event.clickHitsAfterSearch(String eventName, String indexName, String userToken, String queryID, Iterable<String> objectIDs, Iterable<int> positions, {DateTime? timestamp})

Creates a click event after a search with object IDs and positions.

Event.convertFilters(String eventName, String indexName, String userToken, String attribute, Iterable<String> values, {DateTime? timestamp})

Creates a conversion event with filter attribute and values.

Event.convertHits(String eventName, String indexName, String userToken, Iterable<String> objectIDs, {DateTime? timestamp})

Creates a conversion event with object IDs.

Event.convertHitsAfterSearch(String eventName, String indexName, String userToken, String queryID, Iterable<String> objectIDs, {DateTime? timestamp})

Creates a conversion event after a search with object IDs.

Event.viewFilters(String eventName, String indexName, String userToken, String attribute, Iterable<String> values, {DateTime? timestamp})

Creates a view event with filter attribute and values.

Event.viewHits(String eventName, String indexName, String userToken, Iterable<String> objectIDs, {DateTime? timestamp})

Creates a view event with object IDs.

Properties

attribute ↔ String?

The attribute associated with filter-based events (optional).

getter/setter pair

eventName ↔ String

The name of the event.

getter/setter pair

filterValues ↔ Iterable<String>?

The list of filter values associated with filter-based events (optional).

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

indexName ↔ String

The name of the Algolia index associated with the event.

getter/setter pair

objectIDs ↔ Iterable<String>?

The list of object IDs associated with the event (optional).

getter/setter pair

positions ↔ Iterable<int>?

The positions of clicked or converted items (optional).

getter/setter pair

queryID ↔ String?

The query ID associated with the event (optional).

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timestamp ↔ DateTime?

The timestamp when the event occurred (optional).

getter/setter pair

type ↔ EventType

The type of the event (click, conversion, or view).

getter/setter pair

userToken ↔ String

The unique identifier for the user who triggered the event.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override