com.relayrides.pushy.apns

Interface ApnsPushNotification

All Known Implementing Classes:

SimpleApnsPushNotification

public interface ApnsPushNotification

A push notification that can be sent through the Apple Push Notification service (APNs). Push notifications have a token that identifies the device to which it should be sent, a JSON payload, and (optionally) a time at which the notification is invalid and should no longer be delivered.

Author:

Jon Chambers

See Also:

Apple Push Notification Service, TokenUtil, ApnsPayloadBuilder

Method Summary

Methods

Modifier and Type	Method and Description
Date	getDeliveryInvalidationTime() Returns the time at which Apple's push notification service should stop trying to deliver this push notification.
String	getPayload() Returns the JSON-encoded payload of this push notification.
DeliveryPriority	getPriority() Returns the priority with which this push notification should be sent to the receiving device.
byte[]	getToken() Returns the token of the device to which this push notification is to be sent.

Method Detail

getToken

byte[] getToken()

Returns the token of the device to which this push notification is to be sent.

Returns:

an array of bytes containing the token of the device to which this notification is to be sent

getPayload

String getPayload()

Returns the JSON-encoded payload of this push notification.

Returns:

the JSON-encoded payload of this push notification

getDeliveryInvalidationTime

Date getDeliveryInvalidationTime()

Returns the time at which Apple's push notification service should stop trying to deliver this push notification. If null, the push notification service will not attempt to store the notification at all. Note that APNs will only store one notification per device token for redelivery at a time.

Returns:

the time at which this notification can be discarded

See Also:

Provider Communication with Apple Push Notification Service

getPriority

DeliveryPriority getPriority()

Returns the priority with which this push notification should be sent to the receiving device. If null, an immediate delivery priority is assumed.

Returns:

the priority with which this push notification should be sent to the receiving device

See Also:

Provider Communication with Apple Push Notification Service