Package com.relayrides.pushy.apns

Contains classes and interfaces for interacting with the Apple Push Notification service (APNs).

See: Description

Interface Summary

Interface	Description
ApnsConnectionListener<T extends ApnsPushNotification>	An ApnsConnectionListener receives lifecycle events from ApnsConnection instances.
ApnsPushNotification	A push notification that can be sent through the Apple Push Notification service (APNs).
ExpiredTokenListener<T extends ApnsPushNotification>	Listens for expired tokens from the APNs feedback service.
FailedConnectionListener<T extends ApnsPushNotification>	Listens for failed attempts to connect to an APNs gateway.
RejectedNotificationListener<T extends ApnsPushNotification>	Listens for permanent push notification rejections.

Class Summary

Class	Description
ApnsConnection<T extends ApnsPushNotification>	A connection to an APNs gateway.
ApnsConnectionConfiguration	A set of user-configurable options that affect the behavior of an ApnsConnection.
ApnsEnvironment	An APNs environment is a set of servers that provide push notification services.
ExpiredToken	Represents a device token that the APN Feedback Service has reported as expired.
FeedbackConnectionConfiguration	A set of user-configurable options that affect the behavior of a FeedbackServiceConnection.
FeedbackServiceConnection	A connection to the APNs feedback service that listens for expired tokens, then disconnects after a period of inactivity.
PushManager<T extends ApnsPushNotification>	Push managers manage connections to the APNs gateway and send notifications from their queue.
PushManagerConfiguration	A set of user-configurable options that affect the behavior of a PushManager and its associated ApnsConnections.

Enum Summary

Enum	Description
DeliveryPriority	An enumeration of delivery priorities for APNs push notifications.
RejectedNotificationReason	An enumeration of error codes that may be returned by APNs to indicate why a push notification was rejected.

Package com.relayrides.pushy.apns Description

Contains classes and interfaces for interacting with the Apple Push Notification service (APNs).

The PushManager class is the main public-facing class in Pushy. A PushManager manages connections to APNs and manages the queue of outbound notifications. Generally, Pushy users should create a single long-lived PushManager instance per "topic" (or receiving app) and use it throughout the lifetime of their provider application.

The ApnsPushNotification interface represents a single APNs push notification sent to a single device. A simple concrete implementation of the ApnsPushNotification interface (SimpleApnsPushNotification) and tools for constructing push notification payloads can be found in the com.relayrides.pushy.apns.util package.

Author:

Jon Chambers