Package com.mypurecloud.sdk.v2.model

Class WebEventRequest

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

  • Constructor Details

    • WebEventRequest

      public WebEventRequest()

    • WebEventRequest

      public WebEventRequest(Boolean initWithEmptyList)

  • Method Details

    • customerCookieId

      public WebEventRequest customerCookieId(String customerCookieId)
      A UUID representing the customer making the request.

    • getCustomerCookieId

      public String getCustomerCookieId()

    • setCustomerCookieId

      public void setCustomerCookieId(String customerCookieId)

    • eventName

      public WebEventRequest 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)

    • page

      public WebEventRequest page(RequestPage page)
      The webpage where the user interaction occurred.

    • getPage

      public RequestPage getPage()

    • setPage

      public void setPage(RequestPage page)

    • userAgentString

      public WebEventRequest userAgentString(String userAgentString)
      Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15).

    • getUserAgentString

      public String getUserAgentString()

    • setUserAgentString

      public void setUserAgentString(String userAgentString)

    • browser

      public WebEventRequest browser(WebEventBrowser browser)
      Customer's browser.

    • getBrowser

      public WebEventBrowser getBrowser()

    • setBrowser

      public void setBrowser(WebEventBrowser browser)

    • device

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

    • getDevice

      public WebEventDevice getDevice()

    • setDevice

      public void setDevice(WebEventDevice device)

    • searchQuery

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

    • getSearchQuery

      public String getSearchQuery()

    • setSearchQuery

      public void setSearchQuery(String searchQuery)

    • ipAddress

      public WebEventRequest ipAddress(String ipAddress)
      Customer's IP address.

    • getIpAddress

      public String getIpAddress()

    • setIpAddress

      public void setIpAddress(String ipAddress)

    • referrerUrl

      public WebEventRequest referrerUrl(String referrerUrl)
      Identifies the referrer URL that originally generated the request for the current page being viewed.

    • getReferrerUrl

      public String getReferrerUrl()

    • setReferrerUrl

      public void setReferrerUrl(String referrerUrl)

    • attributes

      public WebEventRequest 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 WebEventRequest 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)

    • externalId

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

    • getExternalId

      public String getExternalId()

    • setExternalId

      public void setExternalId(String externalId)

    • createdDate

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