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

Methods

Modifier and Type	Method and Description
void	addVariantInformations(VariantMetricInformation variantMetricInformation)
String	getClientIdentifier() The Client Identifier showing who triggered the Push Notification
String	getIpAddress() The IP from the submitter of the push message request
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
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
Set<VariantMetricInformation>	getVariantInformations() Collection of specific infos around the related variants
void	setClientIdentifier(String clientIdentifier)
void	setIpAddress(String ipAddress)
void	setPushApplicationId(String pushApplicationId)
void	setRawJsonMessage(String rawJsonMessage)
void	setSubmitDate(Date submitDate)
void	setTotalReceivers(long totalReceivers)
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

setRawJsonMessage

public void setRawJsonMessage(String rawJsonMessage)

getIpAddress

public String getIpAddress()

The IP from the submitter of the push message request

setIpAddress

public void setIpAddress(String ipAddress)

getSubmitDate

public Date getSubmitDate()

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

setSubmitDate

public void setSubmitDate(Date submitDate)

getVariantInformations

public Set<VariantMetricInformation> getVariantInformations()

Collection of specific infos around the related variants

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

setPushApplicationId

public void setPushApplicationId(String pushApplicationId)

getClientIdentifier

public String getClientIdentifier()

The Client Identifier showing who triggered the Push Notification

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)

addVariantInformations

public void addVariantInformations(VariantMetricInformation variantMetricInformation)