Package com.mypurecloud.sdk.v2.model

Class AppEventResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.AppEventResponse

All Implemented Interfaces:

Serializable

public class AppEventResponse
extends Object
implements Serializable

AppEventResponse

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AppEventResponse()
AppEventResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
AppEventResponse	app(JourneyApp app)	Application that the customer is interacting with.
AppEventResponse	attributes(Map<String,CustomEventAttribute> attributes)	User-defined attributes associated with a particular event.
AppEventResponse	createdDate(Date createdDate)	UTC timestamp indicating when the event actually took place.
AppEventResponse	customerId(String customerId)	Identifier of the customer in the source of the event.
AppEventResponse	customerIdType(String customerIdType)	Type of identifier for the customer ID (cookie, email etc.).
AppEventResponse	device(Device device)	Customer's device.
boolean	equals(Object o)
AppEventResponse	eventName(String eventName)	Represents the action the customer performed.
AppEventResponse	externalId(String externalId)	An external identifier for the customer.
AppEventResponse	geolocation(JourneyGeolocation geolocation)	Customer's geolocation.
JourneyApp	getApp()
Map<String,CustomEventAttribute>	getAttributes()
Date	getCreatedDate()
String	getCustomerId()
String	getCustomerIdType()
Device	getDevice()
String	getEventName()
String	getExternalId()
JourneyGeolocation	getGeolocation()
String	getId()
String	getIpOrganization()
JourneyCampaign	getMktCampaign()
NetworkConnectivity	getNetworkConnectivity()
String	getScreenName()
SdkLibrary	getSdkLibrary()
String	getSearchQuery()
AppEventResponseSession	getSession()
Map<String,CustomEventAttribute>	getTraits()
int	hashCode()
AppEventResponse	id(String id)	System-generated UUID for the event.
AppEventResponse	ipOrganization(String ipOrganization)	Customer's IP-based organization or ISP name.
AppEventResponse	mktCampaign(JourneyCampaign mktCampaign)	Marketing / traffic source information.
AppEventResponse	networkConnectivity(NetworkConnectivity networkConnectivity)	Information relating to the device's network connectivity.
AppEventResponse	screenName(String screenName)	The name of the screen in the app that the event took place.
AppEventResponse	sdkLibrary(SdkLibrary sdkLibrary)	SDK library used to generate the event.
AppEventResponse	searchQuery(String searchQuery)	Represents the keywords in a customer search query.
AppEventResponse	session(AppEventResponseSession session)	The app session the event belongs to.
void	setApp(JourneyApp app)
void	setAttributes(Map<String,CustomEventAttribute> attributes)
void	setCreatedDate(Date createdDate)
void	setCustomerId(String customerId)
void	setCustomerIdType(String customerIdType)
void	setDevice(Device device)
void	setEventName(String eventName)
void	setExternalId(String externalId)
void	setGeolocation(JourneyGeolocation geolocation)
void	setId(String id)
void	setIpOrganization(String ipOrganization)
void	setMktCampaign(JourneyCampaign mktCampaign)
void	setNetworkConnectivity(NetworkConnectivity networkConnectivity)
void	setScreenName(String screenName)
void	setSdkLibrary(SdkLibrary sdkLibrary)
void	setSearchQuery(String searchQuery)
void	setSession(AppEventResponseSession session)
void	setTraits(Map<String,CustomEventAttribute> traits)
String	toString()
AppEventResponse	traits(Map<String,CustomEventAttribute> traits)	Traits are attributes intrinsic to the customer that may be sent in selected events (e.g. email, givenName, cellPhone).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AppEventResponse

public AppEventResponse()

AppEventResponse

public AppEventResponse(Boolean initWithEmptyList)

Method Details

id

public AppEventResponse id(String id)

System-generated UUID for the event.

getId

public String getId()

setId

public void setId(String id)

customerId

public AppEventResponse customerId(String customerId)

Identifier of the customer in the source of the event.

getCustomerId

public String getCustomerId()

setCustomerId

public void setCustomerId(String customerId)

customerIdType

public AppEventResponse customerIdType(String customerIdType)

Type of identifier for the customer ID (cookie, email etc.).

getCustomerIdType

public String getCustomerIdType()

setCustomerIdType

public void setCustomerIdType(String customerIdType)

eventName

public AppEventResponse 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 AppEventResponse 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 AppEventResponse app(JourneyApp app)

Application that the customer is interacting with.

getApp

public JourneyApp getApp()

setApp

public void setApp(JourneyApp app)

device

public AppEventResponse device(Device device)

Customer's device.

getDevice

public Device getDevice()

setDevice

public void setDevice(Device device)

ipOrganization

public AppEventResponse ipOrganization(String ipOrganization)

Customer's IP-based organization or ISP name.

getIpOrganization

public String getIpOrganization()

setIpOrganization

public void setIpOrganization(String ipOrganization)

geolocation

public AppEventResponse geolocation(JourneyGeolocation geolocation)

Customer's geolocation.

getGeolocation

public JourneyGeolocation getGeolocation()

setGeolocation

public void setGeolocation(JourneyGeolocation geolocation)

sdkLibrary

public AppEventResponse sdkLibrary(SdkLibrary sdkLibrary)

SDK library used to generate the event.

getSdkLibrary

public SdkLibrary getSdkLibrary()

setSdkLibrary

public void setSdkLibrary(SdkLibrary sdkLibrary)

networkConnectivity

public AppEventResponse networkConnectivity(NetworkConnectivity networkConnectivity)

Information relating to the device's network connectivity.

getNetworkConnectivity

public NetworkConnectivity getNetworkConnectivity()

setNetworkConnectivity

public void setNetworkConnectivity(NetworkConnectivity networkConnectivity)

mktCampaign

public AppEventResponse mktCampaign(JourneyCampaign mktCampaign)

Marketing / traffic source information.

getMktCampaign

public JourneyCampaign getMktCampaign()

setMktCampaign

public void setMktCampaign(JourneyCampaign mktCampaign)

session

public AppEventResponse session(AppEventResponseSession session)

The app session the event belongs to.

getSession

public AppEventResponseSession getSession()

setSession

public void setSession(AppEventResponseSession session)

searchQuery

public AppEventResponse searchQuery(String searchQuery)

Represents the keywords in a customer search query.

getSearchQuery

public String getSearchQuery()

setSearchQuery

public void setSearchQuery(String searchQuery)

attributes

public AppEventResponse 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 AppEventResponse traits(Map<String,CustomEventAttribute> traits)

Traits are attributes intrinsic to the customer that may be sent in selected events (e.g. email, givenName, cellPhone).

getTraits

public Map<String,CustomEventAttribute> getTraits()

setTraits

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

externalId

public AppEventResponse externalId(String externalId)

An external identifier for the customer.

getExternalId

public String getExternalId()

setExternalId

public void setExternalId(String externalId)

createdDate

public AppEventResponse createdDate(Date createdDate)

UTC timestamp indicating when the event actually took place. 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