com.notnoop.apns

Interface ApnsDelegate

All Known Subinterfaces:

StartSendingApnsDelegate

All Known Implementing Classes:

ApnsDelegateAdapter

public interface ApnsDelegate

A delegate that gets notified of the status of notification delivery to the Apple Server. The delegate doesn't get notified when the notification actually arrives at the phone.

Field Summary

Fields

Modifier and Type	Field and Description
static ApnsDelegate	EMPTY A no operation delegate that does nothing!

Method Summary

Modifier and Type	Method and Description
void	cacheLengthExceeded(int newCacheLength) The resend cache needed a bigger size (while resending messages)
void	connectionClosed(DeliveryError e, int messageIdentifier) The connection was closed and/or an error packet was received while monitoring was turned on.
void	messageSendFailed(ApnsNotification message, Throwable e) Called when the delivery of the message failed for any reason If message is null, then your notification has been rejected by Apple but it has been removed from the cache so it is not possible to identify which notification caused the error.
void	messageSent(ApnsNotification message, boolean resent) Called when message was successfully sent to the Apple servers
void	notificationsResent(int resendCount) A number of notifications has been queued for resending due to a error-response packet being received.

Field Detail

EMPTY

static final ApnsDelegate EMPTY

A no operation delegate that does nothing!

Method Detail

messageSent

void messageSent(ApnsNotification message,
                 boolean resent)

Called when message was successfully sent to the Apple servers

Parameters:

message - the notification that was sent

resent - whether the notification was resent after an error

messageSendFailed

void messageSendFailed(ApnsNotification message,
                       Throwable e)

Called when the delivery of the message failed for any reason If message is null, then your notification has been rejected by Apple but it has been removed from the cache so it is not possible to identify which notification caused the error. In this case subsequent notifications may be lost. If this happens you should consider increasing your cacheLength value to prevent data loss.

Parameters:

message - the notification that was attempted to be sent

e - the cause and description of the failure

connectionClosed

void connectionClosed(DeliveryError e,
                      int messageIdentifier)

The connection was closed and/or an error packet was received while monitoring was turned on.

Parameters:

e - the delivery error

messageIdentifier - id of the message that failed

cacheLengthExceeded

void cacheLengthExceeded(int newCacheLength)

The resend cache needed a bigger size (while resending messages)

Parameters:

newCacheLength - new size of the resend cache.

notificationsResent

void notificationsResent(int resendCount)

A number of notifications has been queued for resending due to a error-response packet being received.

Parameters:

resendCount - the number of messages being queued for resend