AlgoliaEvent class

Initital implemention by @algirdasmac committed on 15 Jun PR

Constructors

AlgoliaEvent({required AlgoliaEventType eventType, required String eventName, required String index, required String userToken, String? queryID, List<String>? objectIDs, DateTime? timestamp, List<String>? filters, List<int>? positions})

Properties

eventName String
A user-defined string used to categorize events.
final
eventType AlgoliaEventType
An eventType can be a click, a conversion, or a view.
final
filters List<String>?
An array of filters. Limited to 10 filters.
final
hashCode int
The hash code for this object.
no setteroverride
index String
Name of the targeted index.
final
objectIDs List<String>?
An array of index objectId. Limited to 20 objects.
final
positions List<int>?
Position of the click in the list of Algolia search results.
final
queryID String?
Algolia queryID. This is required when an event is tied to a search.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timestamp DateTime?
Time of the event expressed in milliseconds since the Unix epoch. Default: now()
final
userToken String
Name of the targeted index.
final

Methods

copyWith({AlgoliaEventType? eventType, String? eventName, String? index, String? userToken, DateTime? timestamp, String? queryID, List<String>? objectIDs, List<String>? filters, List<int>? positions}) AlgoliaEvent
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() Map<String, dynamic>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override