Index (Pushy 0.6 API)

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

A

addCustomProperty(String, Object) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: Adds a custom property to the payload.
ALTERNATE_APNS_PORT - Static variable in class com.relayrides.pushy.apns.ApnsClient: An alternative port for communication with the APNs gateway.
ApnsClient<T extends ApnsPushNotification> - Class in com.relayrides.pushy.apns: An APNs client sends push notifications to the APNs gateway.
ApnsClient(File, String) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the certificate and key from the given PKCS#12 file.
ApnsClient(File, String, EventLoopGroup) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the certificate and key from the given PKCS#12 file.
ApnsClient(InputStream, String) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the certificate and key from the given PKCS#12 input stream.
ApnsClient(InputStream, String, EventLoopGroup) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the certificate and key from the given PKCS#12 input stream.
ApnsClient(X509Certificate, PrivateKey, String) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the given certificate and key.
ApnsClient(X509Certificate, PrivateKey, String, EventLoopGroup) - Constructor for class com.relayrides.pushy.apns.ApnsClient: Creates a new APNs client that will identify itself to the APNs gateway with the given certificate and key.
ApnsClientMetricsListener - Interface in com.relayrides.pushy.apns: A metrics listener receives events from an ApnsClient that can be used to measure the performance and behavior of the client.
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

ClientNotConnectedException - Exception in com.relayrides.pushy.apns: An exception thrown to indicate that a notification could not be sent because the client was not connected.
ClientNotConnectedException() - Constructor for exception com.relayrides.pushy.apns.ClientNotConnectedException: Constructs a new exception with no message.
ClientNotConnectedException(String) - Constructor for exception com.relayrides.pushy.apns.ClientNotConnectedException: Constructs a new exception with the given message.
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.proxy - package com.relayrides.pushy.apns.proxy: Contains classes and interfaces for working with proxies.
com.relayrides.pushy.apns.util - package com.relayrides.pushy.apns.util: Contains classes for working with APNs tokens and payloads.
connect(String) - Method in class com.relayrides.pushy.apns.ApnsClient: Connects to the given APNs gateway on the default (HTTPS) port (443).
connect(String, int) - Method in class com.relayrides.pushy.apns.ApnsClient: Connects to the given APNs gateway on the given port.
createProxyHandler() - Method in class com.relayrides.pushy.apns.proxy.HttpProxyHandlerFactory
createProxyHandler() - Method in interface com.relayrides.pushy.apns.proxy.ProxyHandlerFactory: Constructs a new proxy handler.
createProxyHandler() - Method in class com.relayrides.pushy.apns.proxy.Socks4ProxyHandlerFactory
createProxyHandler() - Method in class com.relayrides.pushy.apns.proxy.Socks5ProxyHandlerFactory

D

DEFAULT_APNS_PORT - Static variable in class com.relayrides.pushy.apns.ApnsClient: The default (HTTPS) port for communication with the APNs gateway.
DEFAULT_SOUND_FILENAME - Static variable in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: The name of the iOS default push notification sound ("default").
DEFAULT_WRITE_TIMEOUT_MILLIS - Static variable in class com.relayrides.pushy.apns.ApnsClient: The default write timeout, in milliseconds.
DeliveryPriority - Enum in com.relayrides.pushy.apns: An enumeration of delivery priorities for APNs push notifications.
DEVELOPMENT_APNS_HOST - Static variable in class com.relayrides.pushy.apns.ApnsClient: The hostname for the development APNs gateway.
disconnect() - Method in class com.relayrides.pushy.apns.ApnsClient: Gracefully disconnects from the APNs gateway.

E

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

G

getExpiration() - 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.
getExpiration() - 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.
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.
getPriority() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification: Returns the priority with which this push notification should be sent to the receiving device.
getPriority() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification: Returns the priority with which this push notification should be delivered to the receiving device.
getPushNotification() - Method in interface com.relayrides.pushy.apns.PushNotificationResponse: Returns the original push notification sent to the APNs gateway.
getReconnectionFuture() - Method in class com.relayrides.pushy.apns.ApnsClient: Returns a Future that will succeed when the client has re-established a connection to the APNs gateway.
getRejectionReason() - Method in interface com.relayrides.pushy.apns.PushNotificationResponse: Returns the reason for rejection reported by the APNs gateway.
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.util.SimpleApnsPushNotification: Returns the token of the device to which this push notification should be delivered.
getTokenInvalidationTimestamp() - Method in interface com.relayrides.pushy.apns.PushNotificationResponse: If the sent push notification was rejected because the destination token is no longer valid, returns the most recent time at which the APNs gateway confirmed that the token is no longer valid.
getTopic() - Method in interface com.relayrides.pushy.apns.ApnsPushNotification: Returns the topic to which this notification should be sent.
getTopic() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification: Returns the topic to which this push notification should be sent.

H

handleConnectionAttemptFailed(ApnsClient<? extends ApnsPushNotification>) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that a previously-started connection attempt failed.
handleConnectionAttemptStarted(ApnsClient<? extends ApnsPushNotification>) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that the client has started an attempt to connect to an APNs server.
handleConnectionAttemptSucceeded(ApnsClient<? extends ApnsPushNotification>) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that a previously-started connection attempt completed successfully.
handleNotificationAccepted(ApnsClient<? extends ApnsPushNotification>, long) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that a notification that was previously sent to an APNs server was accepted by the server.
handleNotificationRejected(ApnsClient<? extends ApnsPushNotification>, long) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that a notification that was previously sent to an APNs server was rejected by the server.
handleNotificationSent(ApnsClient<? extends ApnsPushNotification>, long) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that a notification was sent to the APNs server.
handleWriteFailure(ApnsClient<? extends ApnsPushNotification>, long) - Method in interface com.relayrides.pushy.apns.ApnsClientMetricsListener: Indicates that an attempt to send a push notification failed before the notification was processed by the APNs server.
hashCode() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification
HttpProxyHandlerFactory - Class in com.relayrides.pushy.apns.proxy: A concrete ProxyHandlerFactory implementation that creates HttpProxyHandler instances.
HttpProxyHandlerFactory(SocketAddress) - Constructor for class com.relayrides.pushy.apns.proxy.HttpProxyHandlerFactory: Creates a new proxy handler factory that will create HTTP proxy handlers that use the proxy at the given address and that will not perform authentication.
HttpProxyHandlerFactory(SocketAddress, String, String) - Constructor for class com.relayrides.pushy.apns.proxy.HttpProxyHandlerFactory: Creates a new proxy handler factory that will create HTTP proxy handlers that use the proxy at the given address and that will authenticate with the given username and password.

I

isAccepted() - Method in interface com.relayrides.pushy.apns.PushNotificationResponse: Indicates whether the push notification was accepted by the APNs gateway.
isConnected() - Method in class com.relayrides.pushy.apns.ApnsClient: Indicates whether this client is connected to the APNs gateway and ready to send push notifications.

P

PRODUCTION_APNS_HOST - Static variable in class com.relayrides.pushy.apns.ApnsClient: The hostname for the production APNs gateway.
ProxyHandlerFactory - Interface in com.relayrides.pushy.apns.proxy: A proxy handler factory creates proxy handlers for use in an ApnsClient's pipeline.
PushNotificationResponse<T extends ApnsPushNotification> - Interface in com.relayrides.pushy.apns: A response from the APNs gateway indicating whether a notification was accepted or rejected.

S

sanitizeTokenString(String) - Static method in class com.relayrides.pushy.apns.util.TokenUtil: Returns a "sanitized" version of the given token string suitable for sending to an APNs server.
sendNotification(T) - Method in class com.relayrides.pushy.apns.ApnsClient: Sends a push notification to the APNs gateway.
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.
setAlertTitle(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: Sets a short description of the notification purpose.
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.
setCategoryName(String) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: Sets the name of the action category name for interactive remote notifications.
setConnectionTimeout(int) - Method in class com.relayrides.pushy.apns.ApnsClient: Sets the maximum amount of time, in milliseconds, that a client will wait to establish a connection with the APNs server before the connection attempt is considered a failure.
setContentAvailable(boolean) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: Sets whether the payload under construction should contain a flag that indicates that new content is available to be downloaded in the background by the receiving app.
setGracefulShutdownTimeout(long) - Method in class com.relayrides.pushy.apns.ApnsClient: Sets the amount of time (in milliseconds) clients should wait for in-progress requests to complete before closing a connection during a graceful shutdown.
setLaunchImageFileName(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.
setLocalizedAlertTitle(String, String[]) - Method in class com.relayrides.pushy.apns.util.ApnsPayloadBuilder: Sets the key of the title string in the receiving app's localized string list to be shown for the push notification.
setMetricsListener(ApnsClientMetricsListener) - Method in class com.relayrides.pushy.apns.ApnsClient: Sets the metrics listener for this client.
setProxyHandlerFactory(ProxyHandlerFactory) - Method in class com.relayrides.pushy.apns.ApnsClient: Sets the proxy handler factory to be used to construct proxy handlers when establishing a new connection to the APNs gateway.
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.
setWriteTimeout(long) - Method in class com.relayrides.pushy.apns.ApnsClient: Sets the write timeout for this client.
SimpleApnsPushNotification - Class in com.relayrides.pushy.apns.util: A simple and immutable implementation of the ApnsPushNotification interface.
SimpleApnsPushNotification(String, String, String) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification: Constructs a new push notification with the given token, topic, and payload.
SimpleApnsPushNotification(String, String, String, Date) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification: Constructs a new push notification with the given token, topic, payload, and expiration time.
SimpleApnsPushNotification(String, String, String, Date, DeliveryPriority) - Constructor for class com.relayrides.pushy.apns.util.SimpleApnsPushNotification: Constructs a new push notification with the given token, topic, payload, delivery expiration time, and delivery priority.
Socks4ProxyHandlerFactory - Class in com.relayrides.pushy.apns.proxy: A concrete ProxyHandlerFactory implementation that creates Socks4ProxyHandler instances.
Socks4ProxyHandlerFactory(SocketAddress) - Constructor for class com.relayrides.pushy.apns.proxy.Socks4ProxyHandlerFactory: Creates a new proxy handler factory that will create SOCKS4 proxy handlers that use the proxy at the given address and that will not perform authentication.
Socks4ProxyHandlerFactory(SocketAddress, String) - Constructor for class com.relayrides.pushy.apns.proxy.Socks4ProxyHandlerFactory: Creates a new proxy handler factory that will create SOCKS4 proxy handlers that use the proxy at the given address and that will authenticate with the given username and password.
Socks5ProxyHandlerFactory - Class in com.relayrides.pushy.apns.proxy: A concrete ProxyHandlerFactory implementation that creates Socks5ProxyHandler instances.
Socks5ProxyHandlerFactory(SocketAddress) - Constructor for class com.relayrides.pushy.apns.proxy.Socks5ProxyHandlerFactory: Creates a new proxy handler factory that will create SOCKS5 proxy handlers that use the proxy at the given address and that will not perform authentication.
Socks5ProxyHandlerFactory(SocketAddress, String, String) - Constructor for class com.relayrides.pushy.apns.proxy.Socks5ProxyHandlerFactory: Creates a new proxy handler factory that will create SOCKS5 proxy handlers that use the proxy at the given address and that will authenticate with the given username and password.

T

TokenUtil - Class in com.relayrides.pushy.apns.util: A utility class for processing APNs token strings.
toString() - Method in class com.relayrides.pushy.apns.util.SimpleApnsPushNotification

V

valueOf(String) - Static method in enum com.relayrides.pushy.apns.DeliveryPriority: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.relayrides.pushy.apns.DeliveryPriority: 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 S T V