Insights class

Insights is the component responsible for sending events related to the user to personalize his search

Implemented types

• EventTracker

Constructors

Insights({required String applicationID, required String apiKey, String? region})

factory

Insights.custom(EventService _service, UserTokenStorage _userTokenStorage)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isEnabled ↔ bool

Flag that blocks the sending of event packets when set to false

getter/setter pair, override-getter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userToken ↔ String

Set custom user token

getter/setter pair

userTokenLeaseTime ← int

Determines how long (in minutes) a user token can be stored in the persistent storage. Default value is 1440 minutes (1 day). If set to 0 or a negative value, the user token will not be stored in persistent storage and will remain in memory.

no getter

Methods

clickedFilters({required String indexName, required String eventName, required String attribute, required List<String> values, DateTime? timestamp}) → void

Send a filters click event Optional custom timestamp can be provided.

override

clickedObjects({required String indexName, required Iterable<String> objectIDs, required String eventName, DateTime? timestamp}) → void

Track a hits click event. Optional custom timestamp can be provided.

override

clickedObjectsAfterSearch({required String indexName, required Iterable<String> objectIDs, required String eventName, required String queryID, required Iterable<int> positions, DateTime? timestamp}) → void

Track a hits click after search event. Optional custom timestamp can be provided.

override

convertedFilters({required String indexName, required String eventName, required String attribute, required List<String> values, DateTime? timestamp}) → void

Send a filters conversion event Optional custom timestamp can be provided.

override

convertedObjects({required String indexName, required String eventName, required Iterable<String> objectIDs, DateTime? timestamp}) → void

Send a hits conversion event Optional custom timestamp can be provided.

override

convertedObjectsAfterSearch({required String indexName, required String eventName, required String queryID, required Iterable<String> objectIDs, DateTime? timestamp}) → void

Track a hits conversion after search event. Optional custom timestamp can be provided.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

viewedFilters({required String indexName, required String eventName, required String attribute, required List<String> values, DateTime? timestamp}) → void

Send a filters conversion event Optional custom timestamp can be provided.

override

viewedObjects({required String indexName, required String eventName, required List<String> objectIDs, DateTime? timestamp}) → void

Send a hits view event Optional custom timestamp can be provided.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited