A B C D E G H I L M N O P R S T V W

A

actionKey(String) - Method in class com.notnoop.apns.PayloadBuilder

Sets the value of action button (the right button to be displayed).

alertBody(String) - Method in class com.notnoop.apns.PayloadBuilder

Sets the alert body text, the text the appears to the user, to the passed value

APNS - Class in com.notnoop.apns

The main class to interact with the APNS Service.

ApnsDelegate - Interface in com.notnoop.apns

A delegate that gets notified of the status of notification delivery to the Apple Server.

ApnsException - Exception in com.notnoop.exceptions

Base class for all the exceptions thrown in Apns Library

ApnsException() - Constructor for exception com.notnoop.exceptions.ApnsException

ApnsException(String) - Constructor for exception com.notnoop.exceptions.ApnsException

ApnsException(Throwable) - Constructor for exception com.notnoop.exceptions.ApnsException

ApnsException(String, Throwable) - Constructor for exception com.notnoop.exceptions.ApnsException

ApnsNotification - Interface in com.notnoop.apns

Represents an APNS notification to be sent to Apple service.

ApnsService - Interface in com.notnoop.apns

Represents the connection and interface to the Apple APNS servers.

ApnsServiceBuilder - Class in com.notnoop.apns

The class is used to create instances of ApnsService.

ApnsServiceBuilder() - Constructor for class com.notnoop.apns.ApnsServiceBuilder

Constructs a new instance of ApnsServiceBuilder

asNonBlocking() - Method in class com.notnoop.apns.ApnsServiceBuilder

Constructs non-blocking queues and sockets connections to send the iPhone notifications.

asPool(int) - Method in class com.notnoop.apns.ApnsServiceBuilder

Constructs a pool of connections to the notification servers.

asQueued() - Method in class com.notnoop.apns.ApnsServiceBuilder

Constructs a new thread with a processing queue to process notification requests.

B

badge(int) - Method in class com.notnoop.apns.PayloadBuilder

Sets the notification badge to be displayed next to the application icon.

build() - Method in class com.notnoop.apns.ApnsServiceBuilder

Returns a fully initialized instance of ApnsService, according to the requested settings.

build() - Method in class com.notnoop.apns.PayloadBuilder

Returns the JSON String representation of the payload according to Apple APNS specification

buildBytes() - Method in class com.notnoop.apns.PayloadBuilder

Returns the bytes representation of the payload according to Apple APNS specification

C

clearBadge() - Method in class com.notnoop.apns.PayloadBuilder

Requests clearing of the badge number next to the application icon.

code() - Method in enum com.notnoop.apns.DeliveryError

The status code as specified by Apple

com.notnoop.apns - package com.notnoop.apns

com.notnoop.exceptions - package com.notnoop.exceptions

connectionClosed(DeliveryError, int) - Method in interface com.notnoop.apns.ApnsDelegate

copy() - Method in class com.notnoop.apns.PayloadBuilder

Returns a copy of this builder

copy() - Method in interface com.notnoop.apns.ReconnectPolicy

Returns a deep copy of this reconnection policy, if needed.

customField(String, Object) - Method in class com.notnoop.apns.PayloadBuilder

Sets any application-specific custom fields.

customFields(Map<String, ? extends Object>) - Method in class com.notnoop.apns.PayloadBuilder

Set any application-specific custom fields.

D

DeliveryError - Enum in com.notnoop.apns

Errors in delivery that may get reported by Apple APN servers

E

EMPTY - Static variable in interface com.notnoop.apns.ApnsDelegate

A NOOP delegate that does nothing!

EnhancedApnsNotification - Class in com.notnoop.apns

Represents an APNS notification to be sent to Apple service.

EnhancedApnsNotification(int, int, String, String) - Constructor for class com.notnoop.apns.EnhancedApnsNotification

Constructs an instance of ApnsNotification.

EnhancedApnsNotification(int, int, byte[], byte[]) - Constructor for class com.notnoop.apns.EnhancedApnsNotification

Constructs an instance of ApnsNotification.

equals(Object) - Method in class com.notnoop.apns.EnhancedApnsNotification

equals(Object) - Method in class com.notnoop.apns.SimpleApnsNotification

G

getDeviceToken() - Method in interface com.notnoop.apns.ApnsNotification

Returns the binary representation of the device token.

getDeviceToken() - Method in class com.notnoop.apns.EnhancedApnsNotification

Returns the binary representation of the device token.

getDeviceToken() - Method in class com.notnoop.apns.SimpleApnsNotification

Returns the binary representation of the device token.

getExpiry() - Method in interface com.notnoop.apns.ApnsNotification

Returns the expiry date of the notification, a fixed UNIX epoch date expressed in seconds

getExpiry() - Method in class com.notnoop.apns.EnhancedApnsNotification

getExpiry() - Method in class com.notnoop.apns.SimpleApnsNotification

getIdentifier() - Method in interface com.notnoop.apns.ApnsNotification

Returns the identifier of the current message.

getIdentifier() - Method in class com.notnoop.apns.EnhancedApnsNotification

getIdentifier() - Method in class com.notnoop.apns.SimpleApnsNotification

getInactiveDevices() - Method in interface com.notnoop.apns.ApnsService

Returns the list of devices that reported failed-delivery attempts to the Apple Feedback services.

getPayload() - Method in interface com.notnoop.apns.ApnsNotification

Returns the binary representation of the payload.

getPayload() - Method in class com.notnoop.apns.EnhancedApnsNotification

Returns the binary representation of the payload.

getPayload() - Method in class com.notnoop.apns.SimpleApnsNotification

Returns the binary representation of the payload.

H

hashCode() - Method in class com.notnoop.apns.EnhancedApnsNotification

hashCode() - Method in class com.notnoop.apns.SimpleApnsNotification

I

InvalidSSLConfig - Exception in com.notnoop.exceptions

Signals that the the provided SSL context settings (e.g.

InvalidSSLConfig() - Constructor for exception com.notnoop.exceptions.InvalidSSLConfig

InvalidSSLConfig(String) - Constructor for exception com.notnoop.exceptions.InvalidSSLConfig

InvalidSSLConfig(Throwable) - Constructor for exception com.notnoop.exceptions.InvalidSSLConfig

InvalidSSLConfig(String, Throwable) - Constructor for exception com.notnoop.exceptions.InvalidSSLConfig

isTooLong() - Method in class com.notnoop.apns.PayloadBuilder

Returns true if the payload built so far is larger than the size permitted by Apple (which is 256 bytes).

L

launchImage(String) - Method in class com.notnoop.apns.PayloadBuilder

Sets the launch image file for the push notification

length() - Method in class com.notnoop.apns.EnhancedApnsNotification

Returns the length of the message in bytes as it is encoded on the wire.

length() - Method in class com.notnoop.apns.PayloadBuilder

Returns the length of payload bytes once marshaled to bytes

length() - Method in class com.notnoop.apns.SimpleApnsNotification

Returns the length of the message in bytes as it is encoded on the wire.

localizedArguments(Collection<String>) - Method in class com.notnoop.apns.PayloadBuilder

Sets the arguments for the alert message localizable message.

localizedArguments(String...) - Method in class com.notnoop.apns.PayloadBuilder

Sets the arguments for the alert message localizable message.

localizedKey(String) - Method in class com.notnoop.apns.PayloadBuilder

Set the notification localized key for the alert body message.

M

marshall() - Method in interface com.notnoop.apns.ApnsNotification

Returns the binary representation of the message as expected by the APNS server.

marshall() - Method in class com.notnoop.apns.EnhancedApnsNotification

Returns the binary representation of the message as expected by the APNS server.

marshall() - Method in class com.notnoop.apns.SimpleApnsNotification

Returns the binary representation of the message as expected by the APNS server.

MAXIMUM_DATE - Static variable in class com.notnoop.apns.EnhancedApnsNotification

The infinite future for the purposes of Apple expiry date

MAXIMUM_EXPIRY - Static variable in class com.notnoop.apns.EnhancedApnsNotification

The infinite future for the purposes of Apple expiry date

messageSendFailed(ApnsNotification, Throwable) - Method in interface com.notnoop.apns.ApnsDelegate

Called when the delivery of the message failed for any reason

messageSent(ApnsNotification) - Method in interface com.notnoop.apns.ApnsDelegate

Called when message was successfully sent to the Apple servers

N

NetworkIOException - Exception in com.notnoop.exceptions

Thrown to indicate that that a network operation has failed: (e.g.

NetworkIOException() - Constructor for exception com.notnoop.exceptions.NetworkIOException

NetworkIOException(String) - Constructor for exception com.notnoop.exceptions.NetworkIOException

NetworkIOException(IOException) - Constructor for exception com.notnoop.exceptions.NetworkIOException

NetworkIOException(String, IOException) - Constructor for exception com.notnoop.exceptions.NetworkIOException

newPayload() - Static method in class com.notnoop.apns.APNS

Returns a new Payload builder

newPayload() - Static method in class com.notnoop.apns.PayloadBuilder

newService() - Static method in class com.notnoop.apns.APNS

Returns a new APNS Service for sending iPhone notifications

noActionButton() - Method in class com.notnoop.apns.PayloadBuilder

Set the notification view to display an action button.

O

ofCode(int) - Static method in enum com.notnoop.apns.DeliveryError

Returns the appropriate DeliveryError enum corresponding to the Apple provided status code

P

PayloadBuilder - Class in com.notnoop.apns

Represents a builder for constructing Payload requests, as specified by Apple Push Notification Programming Guide.

push(String, String) - Method in interface com.notnoop.apns.ApnsService

Sends a push notification with the provided payload to the iPhone of deviceToken.

push(String, String, Date) - Method in interface com.notnoop.apns.ApnsService

push(byte[], byte[]) - Method in interface com.notnoop.apns.ApnsService

Sends a push notification with the provided payload to the iPhone of deviceToken.

push(byte[], byte[], int) - Method in interface com.notnoop.apns.ApnsService

push(Collection<String>, String) - Method in interface com.notnoop.apns.ApnsService

Sends a bulk push notification with the provided payload to iPhone of deviceTokens set.

push(Collection<String>, String, Date) - Method in interface com.notnoop.apns.ApnsService

push(Collection<byte[]>, byte[]) - Method in interface com.notnoop.apns.ApnsService

Sends a bulk push notification with the provided payload to iPhone of deviceTokens set.

push(Collection<byte[]>, byte[], int) - Method in interface com.notnoop.apns.ApnsService

push(ApnsNotification) - Method in interface com.notnoop.apns.ApnsService

Sends the provided notification message to the desired destination.

R

reconnected() - Method in interface com.notnoop.apns.ReconnectPolicy

Callback method to be called whenever the library makes a new connection

ReconnectPolicy - Interface in com.notnoop.apns

Represents the reconnection policy for the library.

ReconnectPolicy.Provided - Enum in com.notnoop.apns

Types of the library provided reconnection policies.

resizeAlertBody(int) - Method in class com.notnoop.apns.PayloadBuilder

Shrinks the alert message body so that the resulting payload message fits within the passed expected payload length.

resizeAlertBody(int, String) - Method in class com.notnoop.apns.PayloadBuilder

Shrinks the alert message body so that the resulting payload message fits within the passed expected payload length.

RuntimeIOException - Exception in com.notnoop.exceptions

Signals that an I/O exception of some sort has occurred.

RuntimeIOException() - Constructor for exception com.notnoop.exceptions.RuntimeIOException

RuntimeIOException(String) - Constructor for exception com.notnoop.exceptions.RuntimeIOException

RuntimeIOException(IOException) - Constructor for exception com.notnoop.exceptions.RuntimeIOException

RuntimeIOException(String, IOException) - Constructor for exception com.notnoop.exceptions.RuntimeIOException

S

shouldReconnect() - Method in interface com.notnoop.apns.ReconnectPolicy

Returns true if the library should initiate a new connection for sending the message.

shrinkBody() - Method in class com.notnoop.apns.PayloadBuilder

Shrinks the alert message body so that the resulting payload message fits within require Apple specification (256 bytes).

shrinkBody(String) - Method in class com.notnoop.apns.PayloadBuilder

Shrinks the alert message body so that the resulting payload message fits within require Apple specification (256 bytes).

SimpleApnsNotification - Class in com.notnoop.apns

Represents an APNS notification to be sent to Apple service.

SimpleApnsNotification(String, String) - Constructor for class com.notnoop.apns.SimpleApnsNotification

Constructs an instance of ApnsNotification.

SimpleApnsNotification(byte[], byte[]) - Constructor for class com.notnoop.apns.SimpleApnsNotification

Constructs an instance of ApnsNotification.

sound(String) - Method in class com.notnoop.apns.PayloadBuilder

Sets the alert sound to be played.

start() - Method in interface com.notnoop.apns.ApnsService

Starts the service.

stop() - Method in interface com.notnoop.apns.ApnsService

Stops the service and frees any allocated resources it created for this service.

T

testConnection() - Method in interface com.notnoop.apns.ApnsService

Test that the service is setup properly and the Apple servers are reachable.

toString() - Method in class com.notnoop.apns.PayloadBuilder

V

valueOf(String) - Static method in enum com.notnoop.apns.DeliveryError

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

valueOf(String) - Static method in enum com.notnoop.apns.ReconnectPolicy.Provided

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

values() - Static method in enum com.notnoop.apns.DeliveryError

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

values() - Static method in enum com.notnoop.apns.ReconnectPolicy.Provided

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

W

withCert(String, String) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the certificate used to connect to Apple APNS servers.

withCert(InputStream, String) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the certificate used to connect to Apple APNS servers.

withDelegate(ApnsDelegate) - Method in class com.notnoop.apns.ApnsServiceBuilder

Sets the delegate of the service, that gets notified of the status of message delivery.

withFeedbackDestination(String, int) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the Feedback for getting failed devices from Apple iPhone Push servers.

withGatewayDestination(String, int) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the gateway server for sending Apple iPhone notifications.

withNoErrorDetection() - Method in class com.notnoop.apns.ApnsServiceBuilder

Disables the enhanced error detection, enabled by the enhanced push notification interface.

withProductionDestination() - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify to use the Apple Production servers as iPhone gateway and feedback servers.

withProxy(Proxy) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the proxy to be used to establish the connections to Apple Servers

withProxySocket(Socket) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the socket to be used as unlying socket to connect to the APN service.

withReconnectPolicy(ReconnectPolicy) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the reconnection policy for the socket connection.

withReconnectPolicy(ReconnectPolicy.Provided) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the reconnection policy for the socket connection.

withSandboxDestination() - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify to use the Apple sandbox servers as iPhone gateway and feedback servers.

withSocksProxy(String, int) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the address of the SOCKS proxy the connection should use.

withSSLContext(SSLContext) - Method in class com.notnoop.apns.ApnsServiceBuilder

Specify the SSLContext that should be used to initiate the connection to Apple Server.

A B C D E G H I L M N O P R S T V W