org.jboss.aerogear.unifiedpush.api

Class VariantMetricInformation

java.lang.Object

org.jboss.aerogear.unifiedpush.api.BaseModel

org.jboss.aerogear.unifiedpush.api.VariantMetricInformation

All Implemented Interfaces:

Serializable

public class VariantMetricInformation
extends BaseModel

Contains metadata about a variant, of the push message request, such as successful delivery to the push network or involved client devices.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VariantMetricInformation()

Method Summary

Modifier and Type	Method and Description
Boolean	getDeliveryStatus() Indicator if the request to the actual push network, for the related variant, was successful or not.
PushMessageInformation	getPushMessageInformation()
String	getReason() In case of an error (deliveryStatus:false), there is most likely a reason which may give some more insights.
Long	getReceivers() Number of receivers for this variant that were found for the submitted push request
Integer	getServedBatches() The number of device token batches that were fully NotificationDispatcher.
Integer	getTotalBatches() The total number of device token batches that were loaded by the TokenLoader.
String	getVariantID() The ID of the involved variant
Long	getVariantOpenCounter() To track how many time this variant has been opened after a Push Notification
void	incrementVariantOpenCounter()
void	setDeliveryStatus(Boolean deliveryStatus)
void	setPushMessageInformation(PushMessageInformation pushMessageInformation)
void	setReason(String reason)
void	setReceivers(Long receivers)
void	setServedBatches(Integer servedBatches)
void	setTotalBatches(Integer totalBatches)
void	setVariantID(String variantID)
void	setVariantOpenCounter(Long variantOpenCounter)

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

VariantMetricInformation

public VariantMetricInformation()

Method Detail

getVariantID

public String getVariantID()

The ID of the involved variant

Returns:

variant ID

setVariantID

public void setVariantID(String variantID)

getReceivers

public Long getReceivers()

Number of receivers for this variant that were found for the submitted push request

Returns:

number of receivers

setReceivers

public void setReceivers(Long receivers)

getDeliveryStatus

public Boolean getDeliveryStatus()

Indicator if the request to the actual push network, for the related variant, was successful or not.

Returns:

status of the delivery

setDeliveryStatus

public void setDeliveryStatus(Boolean deliveryStatus)

getReason

public String getReason()

In case of an error (deliveryStatus:false), there is most likely a reason which may give some more insights.

Returns:

error details

setReason

public void setReason(String reason)

getPushMessageInformation

public PushMessageInformation getPushMessageInformation()

setPushMessageInformation

public void setPushMessageInformation(PushMessageInformation pushMessageInformation)

getVariantOpenCounter

public Long getVariantOpenCounter()

To track how many time this variant has been opened after a Push Notification

Returns:

long , the times this variant has been opened after a Push Notification

setVariantOpenCounter

public void setVariantOpenCounter(Long variantOpenCounter)

incrementVariantOpenCounter

public void incrementVariantOpenCounter()

getServedBatches

public Integer getServedBatches()

The number of device token batches that were fully NotificationDispatcher. Note: The value is updated asynchronously in MetricsCollector.

Returns:

number of device token batches that were fully processed.

setServedBatches

public void setServedBatches(Integer servedBatches)

getTotalBatches

public Integer getTotalBatches()

The total number of device token batches that were loaded by the TokenLoader. Note: The value is updated asynchronously in MetricsCollector.

Returns:

total number of device token batches that were loaded by the TokenLoader.

setTotalBatches

public void setTotalBatches(Integer totalBatches)