com.adobe.target.delivery.v1.model

Class Notification

java.lang.Object

com.adobe.target.delivery.v1.model.RequestDetails

com.adobe.target.delivery.v1.model.Notification

public class Notification
extends RequestDetails

Notification object is used to sent notificaitons regarding what prefetched content was displayed (for views, pageLoad or regional mboxes), which views, pages and mboxes were visited (triggered), and which elements were clicked. Notification request detail will be validated and in case there are validation errors with any token or timestamp the entire request will be invalidated, so there are no cases of inconsistent data, caused by a partially processed notification. that may happen with a partially processed notification. This is different from the approach in the batch mbox v2 API. Mboxes and views are mutually exclusive.

Field Summary

Fields inherited from class com.adobe.target.delivery.v1.model.RequestDetails

$type

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
Notification	addTokensItem(java.lang.String tokensItem)
boolean	equals(java.lang.Object o)
java.lang.String	getId() Notification id will be returned in response and will indicate that the notification was processed successfully.
java.lang.String	getImpressionId() Impression id is used to stitch (link) the current notification with a previous notification or execute request.
NotificationMbox	getMbox() Get mbox
NotificationPageLoad	getPageLoad() Get pageLoad
java.lang.Long	getTimestamp() Timestamp of the notification, in milliseconds elapsed since UNIX epoch.
java.util.List<java.lang.String>	getTokens() A list of tokens for displayed content or clicked selectors, based on the type of notification.
MetricType	getType() Get type
NotificationView	getView() Get view
int	hashCode()
Notification	id(java.lang.String id)
Notification	impressionId(java.lang.String impressionId)
Notification	mbox(NotificationMbox mbox)
Notification	pageLoad(NotificationPageLoad pageLoad)
void	setId(java.lang.String id)
void	setImpressionId(java.lang.String impressionId)
void	setMbox(NotificationMbox mbox)
void	setPageLoad(NotificationPageLoad pageLoad)
void	setTimestamp(java.lang.Long timestamp)
void	setTokens(java.util.List<java.lang.String> tokens)
void	setType(MetricType type)
void	setView(NotificationView view)
Notification	timestamp(java.lang.Long timestamp)
Notification	tokens(java.util.List<java.lang.String> tokens)
java.lang.String	toString()
Notification	type(MetricType type)
Notification	view(NotificationView view)

Methods inherited from class com.adobe.target.delivery.v1.model.RequestDetails

$type, address, get$Type, getAddress, getOrder, getParameters, getProduct, getProfileParameters, order, parameters, product, profileParameters, putParametersItem, putProfileParametersItem, set$Type, setAddress, setOrder, setParameters, setProduct, setProfileParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

Notification

public Notification()

Method Detail

id

public Notification id(java.lang.String id)

getId

public java.lang.String getId()

Notification id will be returned in response and will indicate that the notification was processed successfully.

Returns:

id

setId

public void setId(java.lang.String id)

impressionId

public Notification impressionId(java.lang.String impressionId)

getImpressionId

public java.lang.String getImpressionId()

Impression id is used to stitch (link) the current notification with a previous notification or execute request. In case they both of them match, the second and other subsequent requests will not generate a new impression to the activity, experience etc.

Returns:

impressionId

setImpressionId

public void setImpressionId(java.lang.String impressionId)

type

public Notification type(MetricType type)

getType

public MetricType getType()

Get type

Returns:

type

setType

public void setType(MetricType type)

timestamp

public Notification timestamp(java.lang.Long timestamp)

getTimestamp

public java.lang.Long getTimestamp()

Timestamp of the notification, in milliseconds elapsed since UNIX epoch.

Returns:

timestamp

setTimestamp

public void setTimestamp(java.lang.Long timestamp)

tokens

public Notification tokens(java.util.List<java.lang.String> tokens)

addTokensItem

public Notification addTokensItem(java.lang.String tokensItem)

getTokens

public java.util.List<java.lang.String> getTokens()

A list of tokens for displayed content or clicked selectors, based on the type of notification.

Returns:

tokens

setTokens

public void setTokens(java.util.List<java.lang.String> tokens)

mbox

public Notification mbox(NotificationMbox mbox)

getMbox

public NotificationMbox getMbox()

Get mbox

Returns:

mbox

setMbox

public void setMbox(NotificationMbox mbox)

view

public Notification view(NotificationView view)

getView

public NotificationView getView()

Get view

Returns:

view

setView

public void setView(NotificationView view)

pageLoad

public Notification pageLoad(NotificationPageLoad pageLoad)

getPageLoad

public NotificationPageLoad getPageLoad()

Get pageLoad

Returns:

pageLoad

setPageLoad

public void setPageLoad(NotificationPageLoad pageLoad)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class RequestDetails

hashCode

public int hashCode()

Overrides:

hashCode in class RequestDetails

toString

public java.lang.String toString()

Overrides:

toString in class RequestDetails