com.amazon.device.messaging

Class ADM

java.lang.Object

com.amazon.device.messaging.ADM

public class ADM
extends java.lang.Object

This class provides the core methods to support registering an app instance to use Amazon Device Messaging (ADM).

Note: Although ADM methods are thread-safe, they are not process safe. You should avoid using ADM from different processes of the same app simultaneously.

Since:

{public class com.amazon.device.messaging.ADM {}

Constructor Summary

Constructors

Constructor and Description
ADM(android.content.Context context) The entry point to ADM.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRegistrationId() Obtains the current registration ID for this instance of your app.
boolean	isSupported() Indicates whether ADM is supported on the current device.
void	startRegister() Starts an asynchronous operation that registers your app for receiving ADM messages.
void	startUnregister() Starts an asynchronous operation that unregisters your app from receiving ADM messages.
void	subscribeToTopic(java.lang.String topic) Starts an asynchronous operation that subscribes your app to a topic for receiving ADM messages related to the respective topic.
void	unsubscribeFromTopic(java.lang.String topic) Starts an asynchronous operation that unsubscribes your app from a topic to stop receiving ADM messages related to the respective topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

ADM

public ADM(android.content.Context context)

The entry point to ADM. You may create more than one ADM object and use each on any thread.

Parameters:

context - The context for which to create an ADM object.

Since:

{public com.amazon.device.messaging.ADM(android.content.Context);}

Method Detail

isSupported

public boolean isSupported()

Indicates whether ADM is supported on the current device.

Returns:

true if ADM is present.

Since:

{public boolean isSupported();}

startRegister

public void startRegister()

Starts an asynchronous operation that registers your app for receiving ADM messages. Your ADMMessageHandlerBase receives a ADMMessageHandlerBase.onRegistered(String) callback when startRegister() completes or an ADMMessageHandlerBase.onRegistrationError(String) callback if it fails.

Registration will fail unless an amazon user is signed in to the device.

Throws:

java.lang.IllegalStateException - if ADM is not supported on the device.

Since:

{public void startRegister();}

startUnregister

public void startUnregister()

Starts an asynchronous operation that unregisters your app from receiving ADM messages. Your ADMMessageHandlerBase receives an ADMMessageHandlerBase.onUnregistered(String) callback when startUnregister completes or an ADMMessageHandlerBase.onRegistrationError(String) callback if it fails.

Throws:

java.lang.IllegalStateException - if ADM is not supported on the device.

Since:

{public void startUnregister();}

getRegistrationId

public java.lang.String getRegistrationId()

Obtains the current registration ID for this instance of your app. Registration Ids have a maximum size of 1536 characters.

Returns:

The current registration ID for this app instance or null if the current instance is not registered.

Throws:

java.lang.IllegalStateException - if ADM is not supported on the device.

Since:

{public java.lang.String getRegistrationId();}

subscribeToTopic

public void subscribeToTopic(java.lang.String topic)

Starts an asynchronous operation that subscribes your app to a topic for receiving ADM messages related to the respective topic. Your ADMMessageHandlerJobBase receives a ADMMessageHandlerJobBase.onSubscribe(Context, String) )} callback when subscribeToTopic(String) completes or an ADMMessageHandlerJobBase.onSubscribeError(Context, String, String) callback if it fails.

Throws:

java.lang.IllegalStateException - if ADM is not supported on the device.

Since:

{public void subscribeToTopic(java.lang.String);}

unsubscribeFromTopic

public void unsubscribeFromTopic(java.lang.String topic)

Starts an asynchronous operation that unsubscribes your app from a topic to stop receiving ADM messages related to the respective topic. Your ADMMessageHandlerBase receives a ADMMessageHandlerJobBase.onUnsubscribe(Context, String) callback when unsubscribeFromTopic(String) completes or an ADMMessageHandlerJobBase.onUnsubscribeError(Context, String, String) callback if it fails.

Throws:

java.lang.IllegalStateException - if ADM is not supported on the device.

Since:

{public void unsubscribeFromTopic(java.lang.String);}