Package com.algolia.model.insights

Class ViewedFilters

java.lang.Object
com.algolia.model.insights.ViewedFilters
All Implemented Interfaces:
EventsItems
public class ViewedFilters extends Object implements EventsItems
Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.

  • Constructor Details

    • ViewedFilters

      public ViewedFilters()

  • Method Details

    • setEventName

      public ViewedFilters 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 ViewedFilters setEventType(ViewEvent eventType)

    • getEventType

      @Nonnull public ViewEvent getEventType()
      Get eventType

    • setIndex

      public ViewedFilters setIndex(String index)

    • getIndex

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

    • setFilters

      public ViewedFilters setFilters(List<String> filters)

    • addFilters

      public ViewedFilters addFilters(String filtersItem)

    • getFilters

      @Nonnull public List<String> getFilters()
      Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.

    • setUserToken

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