Package com.mypurecloud.sdk.v2.model

Class AppEvent

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

  • Constructor Details

    • AppEvent

      public AppEvent()

    • AppEvent

      public AppEvent(Boolean initWithEmptyList)

  • Method Details

    • eventName

      public AppEvent 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. screen_viewed, order_completed, user_registered).

    • getEventName

      public String getEventName()

    • setEventName

      public void setEventName(String eventName)

    • screenName

      public AppEvent screenName(String screenName)
      The name of the screen in the app that the event took place.

    • getScreenName

      public String getScreenName()

    • setScreenName

      public void setScreenName(String screenName)

    • app

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

    • getApp

      public JourneyApp getApp()

    • setApp

      public void setApp(JourneyApp app)

    • device

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

    • getDevice

      public Device getDevice()

    • setDevice

      public void setDevice(Device device)

    • ipAddress

      public AppEvent 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 AppEvent ipOrganization(String ipOrganization)
      Customer's IP-based organization or ISP name.

    • getIpOrganization

      public String getIpOrganization()

    • setIpOrganization

      public void setIpOrganization(String ipOrganization)

    • geolocation

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

    • getGeolocation

      public JourneyGeolocation getGeolocation()

    • setGeolocation

      public void setGeolocation(JourneyGeolocation geolocation)

    • sdkLibrary

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

    • getSdkLibrary

      public SdkLibrary getSdkLibrary()

    • setSdkLibrary

      public void setSdkLibrary(SdkLibrary sdkLibrary)

    • networkConnectivity

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

    • getNetworkConnectivity

      public NetworkConnectivity getNetworkConnectivity()

    • setNetworkConnectivity

      public void setNetworkConnectivity(NetworkConnectivity networkConnectivity)

    • mktCampaign

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

    • getMktCampaign

      public JourneyCampaign getMktCampaign()

    • setMktCampaign

      public void setMktCampaign(JourneyCampaign mktCampaign)

    • searchQuery

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

    • getSearchQuery

      public String getSearchQuery()

    • setSearchQuery

      public void setSearchQuery(String searchQuery)

    • attributes

      public AppEvent 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 AppEvent traits(Map<String,CustomEventAttribute> traits)
      Traits are attributes intrinsic to the customer that may be sent in selected events. Examples are email, givenName, cellPhone.

    • getTraits

      public Map<String,CustomEventAttribute> getTraits()

    • setTraits

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

    • 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