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()
      The name of the event, 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()
      The name of an Algolia index.

    • setObjectIDs

      public ClickedObjectIDs setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public ClickedObjectIDs addObjectIDs(String objectIDsItem)

    • getObjectIDs

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

    • setUserToken

      public ClickedObjectIDs setUserToken(String userToken)

    • getUserToken

      @Nonnull public String getUserToken()
      An anonymous or pseudonymous user identifier. > **Note**: Never include personally identifiable information in user tokens.

    • setAuthenticatedUserToken

      public ClickedObjectIDs setAuthenticatedUserToken(String authenticatedUserToken)

    • getAuthenticatedUserToken

      @Nullable public String getAuthenticatedUserToken()
      An identifier for authenticated users. > **Note**: Never include personally identifiable information in user tokens.

    • setTimestamp

      public ClickedObjectIDs setTimestamp(Long timestamp)

    • getTimestamp

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

    • 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