Package com.yandex.metrica.ecommerce

Class ECommerceScreen

java.lang.Object
com.yandex.metrica.ecommerce.ECommerceScreen
public class ECommerceScreen
extends java.lang.Object
Describes a screen (page).

  • Constructor Summary

    Constructors
    Constructor Description
    ECommerceScreen()  

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> getCategoriesPath()  
    java.lang.String getName()  
    java.util.Map<java.lang.String,​java.lang.String> getPayload()  
    java.lang.String getSearchQuery()  
    ECommerceScreen setCategoriesPath​(java.util.List<java.lang.String> categoriesPath)
    Sets screen categories path.
    ECommerceScreen setName​(java.lang.String name)
    Sets screen name.
    ECommerceScreen setPayload​(java.util.Map<java.lang.String,​java.lang.String> payload)
    Sets payload.
    ECommerceScreen setSearchQuery​(java.lang.String searchQuery)
    Sets search query.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ECommerceScreen

      public ECommerceScreen()

  • Method Details

    • getName

      @Nullable public java.lang.String getName()
      Returns:
      screen name
      See Also:
      setName(String)

    • setName

      public ECommerceScreen setName​(@Nullable java.lang.String name)
      Sets screen name.
      Parameters:
      name - Name of the screen.
      Returns:
      same ECommerceScreen object

    • getCategoriesPath

      @Nullable public java.util.List<java.lang.String> getCategoriesPath()
      Returns:
      categories path
      See Also:
      setCategoriesPath(java.util.List)

    • setCategoriesPath

      public ECommerceScreen setCategoriesPath​(@Nullable java.util.List<java.lang.String> categoriesPath)
      Sets screen categories path.
      Parameters:
      categoriesPath - Path to the screen.
      Returns:
      same ECommerceScreen object

    • getSearchQuery

      @Nullable public java.lang.String getSearchQuery()
      Returns:
      search query
      See Also:
      setSearchQuery(String)

    • setSearchQuery

      public ECommerceScreen setSearchQuery​(@Nullable java.lang.String searchQuery)
      Sets search query.
      Parameters:
      searchQuery - Search query.
      Returns:
      same ECommerceScreen object

    • getPayload

      @Nullable public java.util.Map<java.lang.String,​java.lang.String> getPayload()
      Returns:
      payload
      See Also:
      setPayload(java.util.Map)

    • setPayload

      public ECommerceScreen setPayload​(@Nullable java.util.Map<java.lang.String,​java.lang.String> payload)
      Sets payload.
      Parameters:
      payload - Payload - additional key-value structured data with various content.
      Returns:
      same ECommerceScreen object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object