com.adobe.target.delivery.v1.model

Class PageLoadResponse

java.lang.Object

com.adobe.target.delivery.v1.model.PageLoadResponse

public class PageLoadResponse
extends java.lang.Object

Page load response. Contains the result of prefetching or executing a request that will retrieve content for all selectors not associated with a particular view.

Constructor Summary

Constructors

Constructor and Description
PageLoadResponse()

Method Summary

Modifier and Type	Method and Description
PageLoadResponse	addMetricsItem(Metric metricsItem)
PageLoadResponse	addOptionsItem(Option optionsItem)
PageLoadResponse	analytics(AnalyticsResponse analytics)
boolean	equals(java.lang.Object o)
AnalyticsResponse	getAnalytics() Get analytics
java.util.List<Metric>	getMetrics() Click track metrics.
java.util.List<Option>	getOptions() List of options that should be applied.
java.lang.String	getState() View state token that must be sent back with display notification for the view.
java.util.Map<java.lang.String,java.lang.Object>	getTrace() The object containing all trace data for the request, only present if the trace token was provided in the request.
int	hashCode()
PageLoadResponse	metrics(java.util.List<Metric> metrics)
PageLoadResponse	options(java.util.List<Option> options)
PageLoadResponse	putTraceItem(java.lang.String key, java.lang.Object traceItem)
void	setAnalytics(AnalyticsResponse analytics)
void	setMetrics(java.util.List<Metric> metrics)
void	setOptions(java.util.List<Option> options)
void	setState(java.lang.String state)
void	setTrace(java.util.Map<java.lang.String,java.lang.Object> trace)
PageLoadResponse	state(java.lang.String state)
java.lang.String	toString()
PageLoadResponse	trace(java.util.Map<java.lang.String,java.lang.Object> trace)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageLoadResponse

public PageLoadResponse()

Method Detail

options

public PageLoadResponse options(java.util.List<Option> options)

addOptionsItem

public PageLoadResponse addOptionsItem(Option optionsItem)

getOptions

public java.util.List<Option> getOptions()

List of options that should be applied. Note: options that have been set on selectors assigned to views will not be included here.

Returns:

options

setOptions

public void setOptions(java.util.List<Option> options)

metrics

public PageLoadResponse metrics(java.util.List<Metric> metrics)

addMetricsItem

public PageLoadResponse addMetricsItem(Metric metricsItem)

getMetrics

public java.util.List<Metric> getMetrics()

Click track metrics. Note that click metrics for selectors set with views will not be included here. If the same activity is serving content for selectors on a view and selectors unassociated with views, and having click track metrics not associated with any view within the activity, then: * in case of a prefetch-only request, these metrics (tokens) will be set in the prefetch response's metrics. * in case of an execute-only request, the metrics will be set in the pageLoad response's metrics. * in case of a request, with both execute and prefetch, the metrics will be set in the pageLoad response's metrics only.

Returns:

metrics

setMetrics

public void setMetrics(java.util.List<Metric> metrics)

analytics

public PageLoadResponse analytics(AnalyticsResponse analytics)

getAnalytics

public AnalyticsResponse getAnalytics()

Get analytics

Returns:

analytics

setAnalytics

public void setAnalytics(AnalyticsResponse analytics)

state

public PageLoadResponse state(java.lang.String state)

getState

public java.lang.String getState()

View state token that must be sent back with display notification for the view. May only be present for prefetch requests.

Returns:

state

setState

public void setState(java.lang.String state)

trace

public PageLoadResponse trace(java.util.Map<java.lang.String,java.lang.Object> trace)

putTraceItem

public PageLoadResponse putTraceItem(java.lang.String key,
                                     java.lang.Object traceItem)

getTrace

public java.util.Map<java.lang.String,java.lang.Object> getTrace()

The object containing all trace data for the request, only present if the trace token was provided in the request.

Returns:

trace

setTrace

public void setTrace(java.util.Map<java.lang.String,java.lang.Object> trace)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object