Package com.mypurecloud.sdk.v2.model

Class WebEvent

java.lang.Object
com.mypurecloud.sdk.v2.model.WebEvent
All Implemented Interfaces:
Serializable
public class WebEvent extends Object implements Serializable
WebEvent
See Also:

  • Constructor Details

    • WebEvent

      public WebEvent()

    • WebEvent

      public WebEvent(Boolean initWithEmptyList)

  • Method Details

    • eventName

      public WebEvent eventName(String eventName)
      Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered).

    • getEventName

      public String getEventName()

    • setEventName

      public void setEventName(String eventName)

    • totalEventCount

      public WebEvent totalEventCount(Integer totalEventCount)
      The total count of events performed by the customer across all sessions.

    • getTotalEventCount

      public Integer getTotalEventCount()

    • setTotalEventCount

      public void setTotalEventCount(Integer totalEventCount)

    • totalPageviewCount

      public WebEvent totalPageviewCount(Integer totalPageviewCount)
      The total count of pageviews performed by the customer across all sessions.

    • getTotalPageviewCount

      public Integer getTotalPageviewCount()

    • setTotalPageviewCount

      public void setTotalPageviewCount(Integer totalPageviewCount)

    • page

      public WebEvent page(JourneyPage page)
      The webpage where the user interaction occurred.

    • getPage

      public JourneyPage getPage()

    • setPage

      public void setPage(JourneyPage page)

    • userAgentString

      public WebEvent userAgentString(String userAgentString)
      HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15).

    • getUserAgentString

      public String getUserAgentString()

    • setUserAgentString

      public void setUserAgentString(String userAgentString)

    • browser

      public WebEvent browser(Browser browser)
      Customer's browser.

    • getBrowser

      public Browser getBrowser()

    • setBrowser

      public void setBrowser(Browser browser)

    • device

      public WebEvent device(Device device)
      Customer's device.

    • getDevice

      public Device getDevice()

    • setDevice

      public void setDevice(Device device)

    • geolocation

      public WebEvent geolocation(JourneyGeolocation geolocation)
      Customer's geolocation.

    • getGeolocation

      public JourneyGeolocation getGeolocation()

    • setGeolocation

      public void setGeolocation(JourneyGeolocation geolocation)

    • ipAddress

      public WebEvent ipAddress(String ipAddress)
      Customer's IP address. May be null if the business configures the tracker to not collect IP addresses.

    • getIpAddress

      public String getIpAddress()

    • setIpAddress

      public void setIpAddress(String ipAddress)

    • ipOrganization

      public WebEvent ipOrganization(String ipOrganization)
      Customer's IP-based organization or ISP name.

    • getIpOrganization

      public String getIpOrganization()

    • setIpOrganization

      public void setIpOrganization(String ipOrganization)

    • mktCampaign

      public WebEvent mktCampaign(JourneyCampaign mktCampaign)
      Marketing / traffic source information.

    • getMktCampaign

      public JourneyCampaign getMktCampaign()

    • setMktCampaign

      public void setMktCampaign(JourneyCampaign mktCampaign)

    • referrer

      public WebEvent referrer(Referrer referrer)
      Identifies the page URL that originally generated the request for the current page being viewed.

    • getReferrer

      public Referrer getReferrer()

    • setReferrer

      public void setReferrer(Referrer referrer)

    • attributes

      public WebEvent attributes(Map<String,CustomEventAttribute> attributes)
      User-defined attributes associated with a particular event.

    • getAttributes

      public Map<String,CustomEventAttribute> getAttributes()

    • setAttributes

      public void setAttributes(Map<String,CustomEventAttribute> attributes)

    • traits

      public WebEvent traits(Map<String,CustomEventAttribute> traits)
      User-defined traits associated with a particular event.

    • getTraits

      public Map<String,CustomEventAttribute> getTraits()

    • setTraits

      public void setTraits(Map<String,CustomEventAttribute> traits)

    • searchQuery

      public WebEvent searchQuery(String searchQuery)
      Represents the keywords in a customer search query.

    • getSearchQuery

      public String getSearchQuery()

    • setSearchQuery

      public void setSearchQuery(String searchQuery)

    • authenticated

      public WebEvent authenticated(Boolean authenticated)
      Indicates whether the event was produced during an authenticated session.

    • getAuthenticated

      public Boolean getAuthenticated()

    • setAuthenticated

      public void setAuthenticated(Boolean authenticated)

    • 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