Package com.mypurecloud.sdk.v2.model

Class JourneyEventsSettings

java.lang.Object

com.mypurecloud.sdk.v2.model.JourneyEventsSettings

All Implemented Interfaces:

Serializable

public class JourneyEventsSettings
extends Object
implements Serializable

Settings concerning journey events

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JourneyEventsSettings.PageviewConfigEnum	Controls how the pageview events are tracked.

Constructor Summary

Constructors

Constructor	Description
JourneyEventsSettings()
JourneyEventsSettings(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
JourneyEventsSettings	clickEvents(List<SelectorEventTrigger> clickEvents)	Tracks when and where a visitor clicks on a webpage.
JourneyEventsSettings	enabled(Boolean enabled)	Whether or not journey event collection is enabled.
boolean	equals(Object o)
JourneyEventsSettings	excludedQueryParameters(List<String> excludedQueryParameters)	(deprecated) List of parameters to be excluded from the query string.
JourneyEventsSettings	formsTrackEvents(List<FormsTrackTrigger> formsTrackEvents)	Controls how the form submitted and form abandoned events are tracked after a visitor interacts with a form element.
List<SelectorEventTrigger>	getClickEvents()
Boolean	getEnabled()
List<String>	getExcludedQueryParameters()
List<FormsTrackTrigger>	getFormsTrackEvents()
List<IdleEventTrigger>	getIdleEvents()
List<SelectorEventTrigger>	getInViewportEvents()
JourneyEventsSettings.PageviewConfigEnum	getPageviewConfig()
List<ScrollPercentageEventTrigger>	getScrollDepthEvents()
List<String>	getSearchQueryParameters()
Boolean	getShouldKeepUrlFragment()
TrackingSettings	getTrackingSettings()
int	hashCode()
JourneyEventsSettings	idleEvents(List<IdleEventTrigger> idleEvents)	Tracks when and where a visitor becomes inactive on a webpage.
JourneyEventsSettings	inViewportEvents(List<SelectorEventTrigger> inViewportEvents)	Tracks when elements become visible or hidden on screen.
JourneyEventsSettings	pageviewConfig(JourneyEventsSettings.PageviewConfigEnum pageviewConfig)	Controls how the pageview events are tracked.
JourneyEventsSettings	scrollDepthEvents(List<ScrollPercentageEventTrigger> scrollDepthEvents)	Tracks when a visitor scrolls to a specific percentage of a webpage.
JourneyEventsSettings	searchQueryParameters(List<String> searchQueryParameters)	(deprecated) List of query parameters used for search (e.g.
void	setClickEvents(List<SelectorEventTrigger> clickEvents)
void	setEnabled(Boolean enabled)
void	setExcludedQueryParameters(List<String> excludedQueryParameters)
void	setFormsTrackEvents(List<FormsTrackTrigger> formsTrackEvents)
void	setIdleEvents(List<IdleEventTrigger> idleEvents)
void	setInViewportEvents(List<SelectorEventTrigger> inViewportEvents)
void	setPageviewConfig(JourneyEventsSettings.PageviewConfigEnum pageviewConfig)
void	setScrollDepthEvents(List<ScrollPercentageEventTrigger> scrollDepthEvents)
void	setSearchQueryParameters(List<String> searchQueryParameters)
void	setShouldKeepUrlFragment(Boolean shouldKeepUrlFragment)
void	setTrackingSettings(TrackingSettings trackingSettings)
JourneyEventsSettings	shouldKeepUrlFragment(Boolean shouldKeepUrlFragment)	(deprecated) Whether or not to keep the URL fragment.
String	toString()
JourneyEventsSettings	trackingSettings(TrackingSettings trackingSettings)	Configuration settings for tracking behavior and filtering

Methods inherited from class java.lang.Object

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

Constructor Details

JourneyEventsSettings

public JourneyEventsSettings()

JourneyEventsSettings

public JourneyEventsSettings(Boolean initWithEmptyList)

Method Details

enabled

public JourneyEventsSettings enabled(Boolean enabled)

Whether or not journey event collection is enabled.

getEnabled

public Boolean getEnabled()

setEnabled

public void setEnabled(Boolean enabled)

excludedQueryParameters

public JourneyEventsSettings excludedQueryParameters(List<String> excludedQueryParameters)

(deprecated) List of parameters to be excluded from the query string.

getExcludedQueryParameters

public List<String> getExcludedQueryParameters()

setExcludedQueryParameters

public void setExcludedQueryParameters(List<String> excludedQueryParameters)

shouldKeepUrlFragment

public JourneyEventsSettings shouldKeepUrlFragment(Boolean shouldKeepUrlFragment)

(deprecated) Whether or not to keep the URL fragment.

getShouldKeepUrlFragment

public Boolean getShouldKeepUrlFragment()

setShouldKeepUrlFragment

public void setShouldKeepUrlFragment(Boolean shouldKeepUrlFragment)

searchQueryParameters

public JourneyEventsSettings searchQueryParameters(List<String> searchQueryParameters)

(deprecated) List of query parameters used for search (e.g. 'q').

getSearchQueryParameters

public List<String> getSearchQueryParameters()

setSearchQueryParameters

public void setSearchQueryParameters(List<String> searchQueryParameters)

pageviewConfig

public JourneyEventsSettings pageviewConfig(JourneyEventsSettings.PageviewConfigEnum pageviewConfig)

Controls how the pageview events are tracked.

getPageviewConfig

public JourneyEventsSettings.PageviewConfigEnum getPageviewConfig()

setPageviewConfig

public void setPageviewConfig(JourneyEventsSettings.PageviewConfigEnum pageviewConfig)

clickEvents

public JourneyEventsSettings clickEvents(List<SelectorEventTrigger> clickEvents)

Tracks when and where a visitor clicks on a webpage.

getClickEvents

public List<SelectorEventTrigger> getClickEvents()

setClickEvents

public void setClickEvents(List<SelectorEventTrigger> clickEvents)

formsTrackEvents

public JourneyEventsSettings formsTrackEvents(List<FormsTrackTrigger> formsTrackEvents)

Controls how the form submitted and form abandoned events are tracked after a visitor interacts with a form element.

getFormsTrackEvents

public List<FormsTrackTrigger> getFormsTrackEvents()

setFormsTrackEvents

public void setFormsTrackEvents(List<FormsTrackTrigger> formsTrackEvents)

idleEvents

public JourneyEventsSettings idleEvents(List<IdleEventTrigger> idleEvents)

Tracks when and where a visitor becomes inactive on a webpage.

getIdleEvents

public List<IdleEventTrigger> getIdleEvents()

setIdleEvents

public void setIdleEvents(List<IdleEventTrigger> idleEvents)

inViewportEvents

public JourneyEventsSettings inViewportEvents(List<SelectorEventTrigger> inViewportEvents)

Tracks when elements become visible or hidden on screen.

getInViewportEvents

public List<SelectorEventTrigger> getInViewportEvents()

setInViewportEvents

public void setInViewportEvents(List<SelectorEventTrigger> inViewportEvents)

scrollDepthEvents

public JourneyEventsSettings scrollDepthEvents(List<ScrollPercentageEventTrigger> scrollDepthEvents)

Tracks when a visitor scrolls to a specific percentage of a webpage.

getScrollDepthEvents

public List<ScrollPercentageEventTrigger> getScrollDepthEvents()

setScrollDepthEvents

public void setScrollDepthEvents(List<ScrollPercentageEventTrigger> scrollDepthEvents)

trackingSettings

public JourneyEventsSettings trackingSettings(TrackingSettings trackingSettings)

Configuration settings for tracking behavior and filtering

getTrackingSettings

public TrackingSettings getTrackingSettings()

setTrackingSettings

public void setTrackingSettings(TrackingSettings trackingSettings)

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