Package com.algolia.model.insights

Class ClickedObjectIDsAfterSearch

java.lang.Object
com.algolia.model.insights.ClickedObjectIDsAfterSearch
All Implemented Interfaces:
EventsItems
public class ClickedObjectIDsAfterSearch extends Object implements EventsItems
Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event.

  • Constructor Details

    • ClickedObjectIDsAfterSearch

      public ClickedObjectIDsAfterSearch()

  • Method Details

    • setEventName

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

    • getEventType

      @Nonnull public ClickEvent getEventType()
      Get eventType

    • setIndex

      public ClickedObjectIDsAfterSearch setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      The name of an Algolia index.

    • setObjectIDs

      public ClickedObjectIDsAfterSearch setObjectIDs(List<String> objectIDs)

    • addObjectIDs

      public ClickedObjectIDsAfterSearch addObjectIDs(String objectIDsItem)

    • getObjectIDs

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

    • setPositions

      public ClickedObjectIDsAfterSearch setPositions(List<Integer> positions)

    • addPositions

      public ClickedObjectIDsAfterSearch addPositions(Integer positionsItem)

    • getPositions

      @Nonnull public List<Integer> getPositions()
      The position of the clicked item the search results. The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.

    • setQueryID

      public ClickedObjectIDsAfterSearch 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.

    • setUserToken

      public ClickedObjectIDsAfterSearch 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 ClickedObjectIDsAfterSearch setAuthenticatedUserToken(String authenticatedUserToken)

    • getAuthenticatedUserToken

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

    • setTimestamp

      public ClickedObjectIDsAfterSearch 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