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 topic (generally the bundle ID of the receiving app), a JSON payload, and (optionally) a time at which the notification is invalid and should no longer be delivered.

Since:

0.1

Author:

Jon Chambers

See Also:

Local and Remote Notification Programming Guide - Apple Push Notification Service, ApnsPayloadBuilder

Method Summary

Modifier and Type	Method and Description
Date	getExpiration() 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.
String	getToken() Returns the token of the device to which this push notification is to be sent.
String	getTopic() Returns the topic to which this notification should be sent.

Method Detail

getToken

String getToken()

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

Returns:

a string of hexadecimal digits representing the token of the device to which this push notification is to be sent

Since:

0.5

See Also:

APNs Provider API

getPayload

String getPayload()

Returns the JSON-encoded payload of this push notification.

Returns:

the JSON-encoded payload of this push notification

Since:

0.1

See Also:

The Remote Notification Payload

getExpiration

Date getExpiration()

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 re-delivery at a time.

Returns:

the time at which this notification can be discarded

Since:

0.5

See Also:

APNs Provider API

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

Since:

0.4

See Also:

APNs Provider API

getTopic

String getTopic()

Returns the topic to which this notification should be sent. This is generally the bundle ID of the receiving app.

Some (older) APNs certificates contain only a single topic; if this push notification is sent via a client using a single-topic certificate, this topic may be null, in which case the APNs gateway will use the certificate's subject (the bundle ID for the receiving app) as the topic.

Returns:

the topic to which this notification should be sent, or null for the default topic if this notification is sent on a connection with a single-topic certificate

Since:

0.5

See Also:

APNs Provider API