Package com.algolia.model.insights

Class AddedToCartObjectIDsAfterSearch

java.lang.Object

com.algolia.model.insights.AddedToCartObjectIDsAfterSearch

All Implemented Interfaces:

EventsItems

public class AddedToCartObjectIDsAfterSearch
extends Object
implements EventsItems

Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.

Nested Class Summary

Nested classes/interfaces inherited from interface com.algolia.model.insights.EventsItems

EventsItems.Deserializer

Constructor Summary

Constructors

Constructor	Description
AddedToCartObjectIDsAfterSearch()

Method Summary

Modifier and Type	Method	Description
AddedToCartObjectIDsAfterSearch	addObjectData(ObjectDataAfterSearch objectDataItem)
AddedToCartObjectIDsAfterSearch	addObjectIDs(String objectIDsItem)
boolean	equals(Object o)
String	getAuthenticatedUserToken()	User token for authenticated users.
String	getCurrency()	If you include pricing information in the `objectData` parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.
String	getEventName()	Can contain up to 64 ASCII characters.
AddToCartEvent	getEventSubtype()	Get eventSubtype
ConversionEvent	getEventType()	Get eventType
String	getIndex()	Name of the Algolia index.
List<ObjectDataAfterSearch>	getObjectData()	Extra information about the records involved in the event—for example, to add price and quantities of purchased products.
List<String>	getObjectIDs()	List of object identifiers for items of an Algolia index.
String	getQueryID()	Unique identifier for a search query.
Long	getTimestamp()	Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
String	getUserToken()	Anonymous or pseudonymous user identifier.
int	hashCode()
AddedToCartObjectIDsAfterSearch	setAuthenticatedUserToken(String authenticatedUserToken)
AddedToCartObjectIDsAfterSearch	setCurrency(String currency)
AddedToCartObjectIDsAfterSearch	setEventName(String eventName)
AddedToCartObjectIDsAfterSearch	setEventSubtype(AddToCartEvent eventSubtype)
AddedToCartObjectIDsAfterSearch	setEventType(ConversionEvent eventType)
AddedToCartObjectIDsAfterSearch	setIndex(String index)
AddedToCartObjectIDsAfterSearch	setObjectData(List<ObjectDataAfterSearch> objectData)
AddedToCartObjectIDsAfterSearch	setObjectIDs(List<String> objectIDs)
AddedToCartObjectIDsAfterSearch	setQueryID(String queryID)
AddedToCartObjectIDsAfterSearch	setTimestamp(Long timestamp)
AddedToCartObjectIDsAfterSearch	setUserToken(String userToken)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AddedToCartObjectIDsAfterSearch

public AddedToCartObjectIDsAfterSearch()

Method Details

setEventName

public AddedToCartObjectIDsAfterSearch setEventName(String eventName)

getEventName

@Nonnull
public String getEventName()

Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.

setEventType

public AddedToCartObjectIDsAfterSearch setEventType(ConversionEvent eventType)

getEventType

@Nonnull
public ConversionEvent getEventType()

Get eventType

setEventSubtype

public AddedToCartObjectIDsAfterSearch setEventSubtype(AddToCartEvent eventSubtype)

getEventSubtype

@Nonnull
public AddToCartEvent getEventSubtype()

Get eventSubtype

setIndex

public AddedToCartObjectIDsAfterSearch setIndex(String index)

getIndex

@Nonnull
public String getIndex()

Name of the Algolia index.

setQueryID

public AddedToCartObjectIDsAfterSearch setQueryID(String queryID)

getQueryID

@Nonnull
public String getQueryID()

Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.

setObjectIDs

public AddedToCartObjectIDsAfterSearch setObjectIDs(List<String> objectIDs)

addObjectIDs

public AddedToCartObjectIDsAfterSearch addObjectIDs(String objectIDsItem)

getObjectIDs

@Nonnull
public List<String> getObjectIDs()

List of object identifiers for items of an Algolia index.

setObjectData

public AddedToCartObjectIDsAfterSearch setObjectData(List<ObjectDataAfterSearch> objectData)

addObjectData

public AddedToCartObjectIDsAfterSearch addObjectData(ObjectDataAfterSearch objectDataItem)

getObjectData

@Nullable
public List<ObjectDataAfterSearch> getObjectData()

Extra information about the records involved in the event—for example, to add price and quantities of purchased products. If provided, must be the same length as `objectIDs`.

setCurrency

public AddedToCartObjectIDsAfterSearch setCurrency(String currency)

getCurrency

@Nullable
public String getCurrency()

If you include pricing information in the `objectData` parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.

setUserToken

public AddedToCartObjectIDsAfterSearch setUserToken(String userToken)

getUserToken

@Nonnull
public String getUserToken()

Anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.

setTimestamp

public AddedToCartObjectIDsAfterSearch setTimestamp(Long timestamp)

getTimestamp

@Nullable
public Long getTimestamp()

Time of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.

setAuthenticatedUserToken

public AddedToCartObjectIDsAfterSearch setAuthenticatedUserToken(String authenticatedUserToken)

getAuthenticatedUserToken

@Nullable
public String getAuthenticatedUserToken()

User token for authenticated users.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object