A B C D E G H I P R S T V

A

addCustomProperty(String, Object) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Adds a custom property to the payload.

ApnsEnvironment - Class in com.relayrides.pushy.apns

An APNs environment is a set of servers that provide push notification services.

ApnsEnvironment(String, int, String, int, boolean) - Constructor for class com.relayrides.pushy.apns.ApnsEnvironment

Constructs a new APenvironment with the given host names and ports.

ApnsPayloadBuilder - Class in com.relayrides.pushy.apns.util

A utility class for constructing JSON payloads suitable for inclusion in APNs push notifications.

ApnsPayloadBuilder() - Constructor for class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Constructs a new payload builder.

ApnsPushNotification - Interface in com.relayrides.pushy.apns

A push notification that can be sent through the Apple Push Notification service (APNs).

B

buildWithDefaultMaximumLength() - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Returns a JSON representation of the push notification payload under construction.

buildWithMaximumLength(int) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Returns a JSON representation of the push notification payload under construction.

C

com.relayrides.pushy.apns - package com.relayrides.pushy.apns

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

com.relayrides.pushy.apns.util - package com.relayrides.pushy.apns.util

Contains classes for working with APNs tokens and payloads.

D

DEFAULT_SOUND_FILENAME - Static variable in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

The name of the iOS default push notification sound ("default").

E

enqueueAllNotifications(Collection<T>) - Method in class com.relayrides.pushy.apns.PushManager

Enqueues a collection of push notifications for transmission to the APNs service.

enqueuePushNotification(T) - Method in class com.relayrides.pushy.apns.PushManager

Enqueues a push notification for transmission to the APNs service.

equals(Object) - Method in class com.relayrides.pushy.apns.ExpiredToken

equals(Object) - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

ExpiredToken - Class in com.relayrides.pushy.apns

Represents a device token that the APN Feedback Service has reported as expired.

G

getApnsGatewayHost() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the host name of the APNs gateway in this environment.

getApnsGatewayPort() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the TCP port for the APNs gateway in this environment.

getByErrorCode(byte) - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Gets the rejection reason associated with the given error code.

getDeliveryInvalidationTime() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the time at which Apple's push notification service should stop trying to deliver this push notification.

getDeliveryInvalidationTime() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the time at which this push notification is no longer valid and should no longer be delivered.

getEnvironment() - Method in class com.relayrides.pushy.apns.PushManager

Returns the environment in which this PushManager is operating.

getErrorCode() - Method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns the one-byte error code associated with this rejection reason.

getExpiration() - Method in class com.relayrides.pushy.apns.ExpiredToken

Returns the time, rounded to the nearest second, when APNs determined that the application no longer exists on the device.

getExpiredTokens() - Method in class com.relayrides.pushy.apns.PushManager

Queries the APNs feedback service for expired tokens.

getFeedbackHost() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the host name of the APNs feedback service in this environment.

getFeedbackPort() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns the TCP port for the APNs feedback service in this environment.

getKeyStore() - Method in class com.relayrides.pushy.apns.PushManager

Returns the KeyStore containing the client certificate to presented to TLS-enabled APNs servers.

getKeyStorePassword() - Method in class com.relayrides.pushy.apns.PushManager

Returns the key to unlock the KeyStore for this PushManager.

getPayload() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

Returns the JSON-encoded payload of this push notification.

getPayload() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the payload to include in this push notification.

getProductionEnvironment() - Static method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns an APNs environment for connecting to Apple's production servers.

getPushNotification() - Method in class com.relayrides.pushy.apns.SendableApnsPushNotification

Returns the push notification to be sent.

getReason() - Method in exception com.relayrides.pushy.apns.RejectedNotificationException

Returns the reason the notification was rejected by APNs.

getSandboxEnvironment() - Static method in class com.relayrides.pushy.apns.ApnsEnvironment

Returns an APNs environment for connecting to Apple's sandbox servers.

getSequenceNumber() - Method in exception com.relayrides.pushy.apns.RejectedNotificationException

Returns the sequence number of the notification rejected by APNs.

getSequenceNumber() - Method in class com.relayrides.pushy.apns.SendableApnsPushNotification

Returns the channel-specific sequence number for this push notification.

getToken() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification

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

getToken() - Method in class com.relayrides.pushy.apns.ExpiredToken

Returns the token APNs has reported as expired.

getToken() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Returns the token of the device to which this push notification should be delivered.

H

handleRejectedNotification(T, RejectedNotificationException) - Method in interface com.relayrides.pushy.apns.RejectedNotificationListener

Handles a permanent push notification rejection.

hashCode() - Method in class com.relayrides.pushy.apns.ExpiredToken

hashCode() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

I

isTlsRequired() - Method in class com.relayrides.pushy.apns.ApnsEnvironment

Indicates whether this environment requires TLS.

P

PushManager<T extends ApnsPushNotification> - Class in com.relayrides.pushy.apns

A PushManager is the main public-facing point of interaction with APNs.

PushManager(ApnsEnvironment, KeyStore, char[]) - Constructor for class com.relayrides.pushy.apns.PushManager

Constructs a new PushManager that operates in the given environment with the given credentials and a single connection to APNs.

PushManager(ApnsEnvironment, KeyStore, char[], int) - Constructor for class com.relayrides.pushy.apns.PushManager

Constructs a new PushManager that operates in the given environment with the given credentials and the given number of parallel connections to APNs.

R

registerRejectedNotificationListener(RejectedNotificationListener<T>) - Method in class com.relayrides.pushy.apns.PushManager

Registers a listener for notifications rejected by APNs for specific reasons.

RejectedNotificationException - Exception in com.relayrides.pushy.apns

Indicates that a notification was definitively rejected by APNs for a specific reason.

RejectedNotificationException(int, RejectedNotificationReason) - Constructor for exception com.relayrides.pushy.apns.RejectedNotificationException

Constructs a new rejected notification exception indicating that the notification sent with the given sequence number was rejected for the given reason.

RejectedNotificationListener<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns

Listens for permanent push notification rejections.

RejectedNotificationReason - Enum in com.relayrides.pushy.apns

An enumeration of error codes that may be returned by APNs to indicate why a push notification was rejected.

S

SendableApnsPushNotification<T extends ApnsPushNotification> - Class in com.relayrides.pushy.apns

Represents a push notification wrapped with transmission-related metadata ready to be sent to an APNs server.

SendableApnsPushNotification(T, int) - Constructor for class com.relayrides.pushy.apns.SendableApnsPushNotification

Constructs a sendable push notification with the given base notification and sequence number.

setAlertBody(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the literal text of the alert message to be shown for the push notification.

setBadgeNumber(Integer) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the number to display as the badge of the icon of the application that receives the push notification.

setLaunchImage(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the image to be shown when the receiving app launches in response to this push notification.

setLocalizedActionButtonKey(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the key of a string in the receiving app's localized string list to be used as the label of the "action" button if the push notification is displayed as an alert.

setLocalizedAlertMessage(String, String[]) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the key of a message in the receiving app's localized string list to be shown for the push notification.

setShowActionButton(boolean) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets whether an "action" button should be shown if the push notification is displayed as an alert.

setSoundFileName(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder

Sets the name of the sound file to play when the push notification is received.

shutdown() - Method in class com.relayrides.pushy.apns.PushManager

Disconnects from the APNs and gracefully shuts down all worker threads.

SimpleApnsPushNotification - Class in com.relayrides.pushy.apns.util

A simple and immutable implementation of the ApnsPushNotification interface.

SimpleApnsPushNotification(byte[], String) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token and payload.

SimpleApnsPushNotification(byte[], String, Date) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

Constructs a new push notification with the given token, payload, and delivery expiration time.

start() - Method in class com.relayrides.pushy.apns.PushManager

Opens all connections to APNs and prepares to send push notifications.

T

tokenBytesToString(byte[]) - Static method in class com.relayrides.pushy.apns.util.TokenUtil

Converts an array of bytes into a string of hexadecimal characters representing the values in the array.

tokenStringToByteArray(String) - Static method in class com.relayrides.pushy.apns.util.TokenUtil

Converts a string of hexadecimal characters into a byte array.

TokenUtil - Class in com.relayrides.pushy.apns.util

A utility class for converting APNS device tokens between byte arrays and hexadecimal strings.

toString() - Method in class com.relayrides.pushy.apns.ExpiredToken

toString() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

V

valueOf(String) - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.relayrides.pushy.apns.RejectedNotificationReason

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I P R S T V