Package com.algolia.model.insights

Class AddedToCartObjectIDs

java.lang.Object
com.algolia.model.insights.AddedToCartObjectIDs
All Implemented Interfaces:
EventsItems
public class AddedToCartObjectIDs extends Object implements EventsItems
Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event.

  • Constructor Details

    • AddedToCartObjectIDs

      public AddedToCartObjectIDs()

  • Method Details

    • setEventName

      public AddedToCartObjectIDs setEventName(String eventName)

    • getEventName

      @Nonnull public String getEventName()
      Event name, 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 AddedToCartObjectIDs setEventType(ConversionEvent eventType)

    • getEventType

      @Nonnull public ConversionEvent getEventType()
      Get eventType

    • setEventSubtype

      public AddedToCartObjectIDs setEventSubtype(AddToCartEvent eventSubtype)

    • getEventSubtype

      @Nonnull public AddToCartEvent getEventSubtype()
      Get eventSubtype

    • setIndex

      public AddedToCartObjectIDs setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      Index name to which the event's items belong.

    • setObjectIDs

      public AddedToCartObjectIDs setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public AddedToCartObjectIDs addObjectIDs(String objectIDsItem)

    • getObjectIDs

      @Nonnull public List<String> getObjectIDs()
      Object IDs of the records that are part of the event.

    • setUserToken

      public AddedToCartObjectIDs setUserToken(String userToken)

    • getUserToken

      @Nonnull public String getUserToken()
      Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).

    • setAuthenticatedUserToken

      public AddedToCartObjectIDs setAuthenticatedUserToken(String authenticatedUserToken)

    • getAuthenticatedUserToken

      @Nullable public String getAuthenticatedUserToken()
      Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).

    • setCurrency

      public AddedToCartObjectIDs setCurrency(String currency)

    • getCurrency

      @Nullable public String getCurrency()
      Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).

    • setObjectData

      public AddedToCartObjectIDs setObjectData(List<ObjectData> objectData)

    • addObjectData

      public AddedToCartObjectIDs addObjectData(ObjectData objectDataItem)

    • getObjectData

      @Nullable public List<ObjectData> getObjectData()
      Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as `objectIDs`.

    • setTimestamp

      public AddedToCartObjectIDs setTimestamp(Long timestamp)

    • getTimestamp

      @Nullable public Long getTimestamp()
      Timestamp 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.

    • setValue

      public AddedToCartObjectIDs setValue(Value value)

    • getValue

      @Nullable public Value getValue()
      Get value

    • 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