org.jboss.aerogear.unifiedpush.api

Class PushMessageInformation

java.lang.Object

org.jboss.aerogear.unifiedpush.api.BaseModel

org.jboss.aerogear.unifiedpush.api.PushMessageInformation

All Implemented Interfaces:

Serializable

public class PushMessageInformation
extends BaseModel

Metadata object that contains various informations around a submitted push message request

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PushMessageInformation()

Method Summary

Modifier and Type	Method and Description
void	addVariantInformations(VariantMetricInformation variantMetricInformation)
Long	getAppOpenCounter() The number of time this Push Application was opened after a Push Notification
String	getClientIdentifier() The Client Identifier showing who triggered the Push Notification
Date	getFirstOpenDate() The date of the first time this Push Application was opened after a Push Notification
String	getIpAddress() The IP from the submitter of the push message request
Date	getLastOpenDate() The date of the last time this Push Application was opened after a Push Notification
String	getPushApplicationId() The ID of the root push application, for which the push message request has been submitted
String	getRawJsonMessage() The raw JSON payload of the push message request
Integer	getServedVariants() The number of variants that were fully processed (all batches were served).
Date	getSubmitDate() The date when the push message request has been processed on the UPS
Long	getTotalReceivers() The number of active tokens, regardless from the variants, to which this Push Message was sent to
Integer	getTotalVariants() The total number of variants to be served for the given push message.
Set<VariantMetricInformation>	getVariantInformations() Collection of specific infos around the related variants
void	incrementAppOpenCounter() Increment the AppOpenCounter
void	setAppOpenCounter(Long appOpenCounter)
void	setClientIdentifier(String clientIdentifier)
void	setFirstOpenDate(Date firstOpenDate)
void	setIpAddress(String ipAddress)
void	setLastOpenDate(Date lastOpenDate)
void	setPushApplicationId(String pushApplicationId)
void	setRawJsonMessage(String rawJsonMessage)
void	setServedVariants(Integer servedVariants)
void	setSubmitDate(Date submitDate)
void	setTotalReceivers(Long totalReceivers)
void	setTotalVariants(Integer totalVariants)
void	setVariantInformations(Set<VariantMetricInformation> variantInformations)

Methods inherited from class org.jboss.aerogear.unifiedpush.api.BaseModel

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushMessageInformation

public PushMessageInformation()

Method Detail

getRawJsonMessage

public String getRawJsonMessage()

The raw JSON payload of the push message request

Returns:

raw json

setRawJsonMessage

public void setRawJsonMessage(String rawJsonMessage)

getIpAddress

public String getIpAddress()

The IP from the submitter of the push message request

Returns:

the ip address

setIpAddress

public void setIpAddress(String ipAddress)

getSubmitDate

public Date getSubmitDate()

The date when the push message request has been processed on the UPS

Returns:

timestamp

setSubmitDate

public void setSubmitDate(Date submitDate)

getVariantInformations

public Set<VariantMetricInformation> getVariantInformations()

Collection of specific infos around the related variants

Returns:

variant information

setVariantInformations

public void setVariantInformations(Set<VariantMetricInformation> variantInformations)

getPushApplicationId

public String getPushApplicationId()

The ID of the root push application, for which the push message request has been submitted

Returns:

containing application ID

setPushApplicationId

public void setPushApplicationId(String pushApplicationId)

getClientIdentifier

public String getClientIdentifier()

The Client Identifier showing who triggered the Push Notification

Returns:

string identifying the sender

setClientIdentifier

public void setClientIdentifier(String clientIdentifier)

getTotalReceivers

public Long getTotalReceivers()

The number of active tokens, regardless from the variants, to which this Push Message was sent to

Returns:

the total of active tokens that received this Push Message

setTotalReceivers

public void setTotalReceivers(Long totalReceivers)

getAppOpenCounter

public Long getAppOpenCounter()

The number of time this Push Application was opened after a Push Notification

Returns:

the number of time this Push Application was opened after a Push Notification

setAppOpenCounter

public void setAppOpenCounter(Long appOpenCounter)

incrementAppOpenCounter

public void incrementAppOpenCounter()

Increment the AppOpenCounter

getFirstOpenDate

public Date getFirstOpenDate()

The date of the first time this Push Application was opened after a Push Notification

Returns:

the date of the first time this Push Application was opened after a Push Notification

setFirstOpenDate

public void setFirstOpenDate(Date firstOpenDate)

getLastOpenDate

public Date getLastOpenDate()

The date of the last time this Push Application was opened after a Push Notification

Returns:

the date of the last time this Push Application was opened after a Push Notification

setLastOpenDate

public void setLastOpenDate(Date lastOpenDate)

getServedVariants

public Integer getServedVariants()

The number of variants that were fully processed (all batches were served). When getServedVariants() is equal to getTotalVariants(), the push message was fully processed.

Returns:

number of variants that were fully processed (all batches were served)

setServedVariants

public void setServedVariants(Integer servedVariants)

getTotalVariants

public Integer getTotalVariants()

The total number of variants to be served for the given push message. When getTotalVariants() is equal to getServedVariants(), the push message was fully processed.

Returns:

total number of variants to be served for the given push message.

setTotalVariants

public void setTotalVariants(Integer totalVariants)

addVariantInformations

public void addVariantInformations(VariantMetricInformation variantMetricInformation)