Package com.algolia.model.insights

Class ClickedObjectIDs

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

  • Constructor Details

    • ClickedObjectIDs

      public ClickedObjectIDs()

  • Method Details

    • setEventName

      public ClickedObjectIDs 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 ClickedObjectIDs setEventType(ClickEvent eventType)

    • getEventType

      @Nonnull public ClickEvent getEventType()
      Get eventType

    • setIndex

      public ClickedObjectIDs setIndex(String index)

    • getIndex

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

    • setObjectIDs

      public ClickedObjectIDs setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public ClickedObjectIDs addObjectIDs(String objectIDsItem)

    • getObjectIDs

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

    • setUserToken

      public ClickedObjectIDs 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 ClickedObjectIDs 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/).

    • setTimestamp

      public ClickedObjectIDs setTimestamp(Long timestamp)

    • getTimestamp

      @Nullable public Long getTimestamp()
      Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.

    • 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