Package com.mypurecloud.sdk.v2.model

Class AppEventRequest

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

  • Constructor Details

    • AppEventRequest

      public AppEventRequest()

    • AppEventRequest

      public AppEventRequest(Boolean initWithEmptyList)

  • Method Details

    • eventName

      public AppEventRequest 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. screen_viewed, search_performed, user_registered.

    • getEventName

      public String getEventName()

    • setEventName

      public void setEventName(String eventName)

    • screenName

      public AppEventRequest screenName(String screenName)
      The name of the screen, view, or fragment in the app where the event took place.

    • getScreenName

      public String getScreenName()

    • setScreenName

      public void setScreenName(String screenName)

    • app

      public AppEventRequest app(JourneyApp app)
      Application that the customer is interacting with.

    • getApp

      public JourneyApp getApp()

    • setApp

      public void setApp(JourneyApp app)

    • device

      public AppEventRequest device(RequestDevice device)
      Customer's device.

    • getDevice

      public RequestDevice getDevice()

    • setDevice

      public void setDevice(RequestDevice device)

    • sdkLibrary

      public AppEventRequest sdkLibrary(SdkLibrary sdkLibrary)
      SDK library used to generate the event.

    • getSdkLibrary

      public SdkLibrary getSdkLibrary()

    • setSdkLibrary

      public void setSdkLibrary(SdkLibrary sdkLibrary)

    • networkConnectivity

      public AppEventRequest networkConnectivity(NetworkConnectivity networkConnectivity)
      Information relating to the device's network connectivity.

    • getNetworkConnectivity

      public NetworkConnectivity getNetworkConnectivity()

    • setNetworkConnectivity

      public void setNetworkConnectivity(NetworkConnectivity networkConnectivity)

    • referrerUrl

      public AppEventRequest referrerUrl(String referrerUrl)
      The referrer URL of the first event in the app session.

    • getReferrerUrl

      public String getReferrerUrl()

    • setReferrerUrl

      public void setReferrerUrl(String referrerUrl)

    • searchQuery

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

    • getSearchQuery

      public String getSearchQuery()

    • setSearchQuery

      public void setSearchQuery(String searchQuery)

    • attributes

      public AppEventRequest 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 AppEventRequest 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 AppEventRequest externalId(String externalId)
      An external identifier for the customer.

    • getExternalId

      public String getExternalId()

    • setExternalId

      public void setExternalId(String externalId)

    • customerCookieId

      public AppEventRequest customerCookieId(String customerCookieId)
      A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution.

    • getCustomerCookieId

      public String getCustomerCookieId()

    • setCustomerCookieId

      public void setCustomerCookieId(String customerCookieId)

    • createdDate

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