Package com.mypurecloud.sdk.v2.model

Class WebEventResponse

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

  • Constructor Details

    • WebEventResponse

      public WebEventResponse()

    • WebEventResponse

      public WebEventResponse(Boolean initWithEmptyList)

  • Method Details

    • customerId

      public WebEventResponse customerId(String customerId)
      Identifier of the customer in the source of the event.

    • getCustomerId

      public String getCustomerId()

    • setCustomerId

      public void setCustomerId(String customerId)

    • eventName

      public WebEventResponse eventName(String eventName)
      Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. 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)

    • customerIdType

      public WebEventResponse customerIdType(String customerIdType)
      Type of identifier for the customer ID (e.g., cookie).

    • getCustomerIdType

      public String getCustomerIdType()

    • setCustomerIdType

      public void setCustomerIdType(String customerIdType)

    • page

      public WebEventResponse page(ResponsePage page)
      The webpage where the user interaction occurred.

    • getPage

      public ResponsePage getPage()

    • setPage

      public void setPage(ResponsePage page)

    • userAgentString

      public WebEventResponse 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 WebEventResponse browser(WebEventBrowser browser)
      Customer's browser.

    • getBrowser

      public WebEventBrowser getBrowser()

    • setBrowser

      public void setBrowser(WebEventBrowser browser)

    • device

      public WebEventResponse device(WebEventDevice device)
      Customer's device.

    • getDevice

      public WebEventDevice getDevice()

    • setDevice

      public void setDevice(WebEventDevice device)

    • searchQuery

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

    • getSearchQuery

      public String getSearchQuery()

    • setSearchQuery

      public void setSearchQuery(String searchQuery)

    • ipOrganization

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

    • getIpOrganization

      public String getIpOrganization()

    • setIpOrganization

      public void setIpOrganization(String ipOrganization)

    • geolocation

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

    • getGeolocation

      public JourneyGeolocation getGeolocation()

    • setGeolocation

      public void setGeolocation(JourneyGeolocation geolocation)

    • mktCampaign

      public WebEventResponse mktCampaign(JourneyCampaign mktCampaign)
      Urchin Tracking Module (UTM) parameters used to track the effectiveness of online marketing campaigns.

    • getMktCampaign

      public JourneyCampaign getMktCampaign()

    • setMktCampaign

      public void setMktCampaign(JourneyCampaign mktCampaign)

    • session

      public WebEventResponse session(WebEventResponseSession session)
      The session that the event belongs to.

    • getSession

      public WebEventResponseSession getSession()

    • setSession

      public void setSession(WebEventResponseSession session)

    • referrer

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

    • getReferrer

      public Referrer getReferrer()

    • setReferrer

      public void setReferrer(Referrer referrer)

    • attributes

      public WebEventResponse attributes(Map<String,CustomEventAttribute> attributes)
      User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.

    • getAttributes

      public Map<String,CustomEventAttribute> getAttributes()

    • setAttributes

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

    • traits

      public WebEventResponse traits(Map<String,CustomEventAttribute> traits)
      Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, givenName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.

    • getTraits

      public Map<String,CustomEventAttribute> getTraits()

    • setTraits

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

    • authenticated

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

    • getAuthenticated

      public Boolean getAuthenticated()

    • setAuthenticated

      public void setAuthenticated(Boolean authenticated)

    • externalId

      public WebEventResponse externalId(String externalId)
      An external identifier for the customer.

    • getExternalId

      public String getExternalId()

    • setExternalId

      public void setExternalId(String externalId)

    • createdDate

      public WebEventResponse createdDate(Date createdDate)
      UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getCreatedDate

      public Date getCreatedDate()

    • setCreatedDate

      public void setCreatedDate(Date createdDate)

    • 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