com.amazon.device.messaging

Class ADMMessageHandlerJobBase

java.lang.Object

com.amazon.device.messaging.ADMMessageHandlerJobBase

public abstract class ADMMessageHandlerJobBase
extends java.lang.Object

This class allows your app to receive messages sent via ADM.

To receive messages with ADM, your app creates a Job that inherits from this class, as well as a broadcast receiver that inherits from ADMMessageReceiver. For an example of using this class, see Integrating Your App with ADM.

All methods on this class are called on JobScheduler's(background) thread. It is not safe to do long-running operations in these methods as they can be stopped at any time and will be subject to background execution restrictions on android API 26 and above

Since:

{public abstract class com.amazon.device.messaging.ADMMessageHandlerJobBase {}

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ADMMessageHandlerJobBase()

Method Summary

Modifier and Type	Method and Description
protected abstract void	onMessage(android.content.Context context, android.content.Intent intent) Called each time ADM delivers a message to an instance of your app.
protected abstract void	onRegistered(android.content.Context context, java.lang.String registrationId) Called when a registration request succeeds.
protected abstract void	onRegistrationError(android.content.Context context, java.lang.String errorId) Called when a registration request fails.
protected void	onSubscribe(android.content.Context context, java.lang.String topic) Called on successful subscription to a topic.
protected void	onSubscribeError(android.content.Context context, java.lang.String topic, java.lang.String errorId) Called when a subscription request fails.
protected abstract void	onUnregistered(android.content.Context context, java.lang.String registrationId) Called on successful unregistration.
protected void	onUnsubscribe(android.content.Context context, java.lang.String topic) Called on successful unsubscription from a topic.
protected void	onUnsubscribeError(android.content.Context context, java.lang.String topic, java.lang.String errorId) Called when a unsubscription request fails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ADMMessageHandlerJobBase

protected ADMMessageHandlerJobBase()

Since:

{protected com.amazon.device.messaging.ADMMessageHandlerJobBase();}

Method Detail

onMessage

protected abstract void onMessage(android.content.Context context,
                                  android.content.Intent intent)

Called each time ADM delivers a message to an instance of your app.

Parameters:

context - A context to your application

intent - An intent containing the message and associated data. You extract the message content from the set of extras attached to the com.amazon.device.messaging.intent.RECEIVE intent. For an example of defining the behavior of the onMessage() callback, see SampleADMMessageHandler.java in the ADMMessenger sample app.

Since:

{protected abstract void onMessage(android.content.Context, android.content.Intent);}

onRegistrationError

protected abstract void onRegistrationError(android.content.Context context,
                                            java.lang.String errorId)

Called when a registration request fails. You should consider a registration error fatal. In response, your app may degrade gracefully, or you may wish to notify the user that this part of your app's functionality is not available.

Parameters:

context - A context to your application

errorId - one of the following values:

• ADMConstants.ERROR_AUTHENTICATION_FAILED
• ADMConstants.ERROR_INVALID_SENDER
• ADMConstants.ERROR_SERVICE_NOT_AVAILABLE

Since:

{protected abstract void onRegistrationError(android.content.Context, java.lang.String);}

onRegistered

protected abstract void onRegistered(android.content.Context context,
                                     java.lang.String registrationId)

Called when a registration request succeeds. ADM may call this message in response to your app calling ADM.startRegister() or if ADM has updated the registration ID for this app instance.

Parameters:

context - A context to your application

registrationId - The new registration ID for the instance of your app. Pass this value to your components that are using ADM to send messages. The ADM.getRegistrationId() method also obtains the registration ID for an instance of your app.

Since:

{protected abstract void onRegistered(android.content.Context, java.lang.String);}

onUnregistered

protected abstract void onUnregistered(android.content.Context context,
                                       java.lang.String registrationId)

Called on successful unregistration. This method may be called in response to your app calling ADM.startUnregister() or if ADM has unregistered the app for some reason (typically because the device has lost its association with a user's Amazon account). If this message is called, your app should notify your components that are using ADM to send messages, so that they know this instance of your app is no longer a valid recipient.

Parameters:

context - A context to your application

registrationId - The registration ID for the instance of your app that is now unregistered. This ID is no longer a valid destination for messages. Calling ADM.getRegistrationId() will show the registration ID for an unregistered app as null.

Since:

{protected abstract void onUnregistered(android.content.Context, java.lang.String);}

onSubscribe

protected void onSubscribe(android.content.Context context,
                           java.lang.String topic)

Called on successful subscription to a topic. This method may be called in response to your app calling ADM.subscribeToTopic(String) Topic()}

Parameters:

context - A context to your application

topic - topic the app is subscribed to

Since:

{protected void onSubscribe(android.content.Context, java.lang.String);}

onSubscribeError

protected void onSubscribeError(android.content.Context context,
                                java.lang.String topic,
                                java.lang.String errorId)

Called when a subscription request fails.

Parameters:

context - A context to your application

topic - topic the app was trying to subscribe

errorId - one of the following values:

Since:

{protected void onSubscribeError(android.content.Context, java.lang.String, java.lang.String);}

onUnsubscribe

protected void onUnsubscribe(android.content.Context context,
                             java.lang.String topic)

Called on successful unsubscription from a topic. This method may be called in response to your app calling ADM.unsubscribeFromTopic(String) Topic()}

Parameters:

context - A context to your application

topic - topic the app is unsubscribed from

Since:

{protected void onUnsubscribe(android.content.Context, java.lang.String);}

onUnsubscribeError

protected void onUnsubscribeError(android.content.Context context,
                                  java.lang.String topic,
                                  java.lang.String errorId)

Called when a unsubscription request fails.

Parameters:

context - A context to your application

topic - topic the app was trying to unsubscribe

errorId - one of the following values:

Since:

{protected void onUnsubscribeError(android.content.Context, java.lang.String, java.lang.String);}