com.amazonaws.mobileconnectors.pinpoint.targeting.notification

Class NotificationClient

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.targeting.notification.NotificationClient

public class NotificationClient
extends java.lang.Object

NotificationClient is the entry point into the Amazon Mobile Analytics SDK to handle Pinpoint notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationClient.CampaignPushResult Deprecated. see NotificationClient.PushResult
static class	NotificationClient.PushResult Result values of handling a Pinpoint push message.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADM_INTENT_ACTION Intent action for ADM
static java.lang.String	BAIDU_INTENT_ACTION Intent action for Baidu
static java.lang.String	FCM_INTENT_ACTION Intent action for FCM
static java.lang.String	GCM_INTENT_ACTION Intent action for GCM
static java.lang.String	INTENT_SNS_NOTIFICATION_DATA Intent Key for GCM bundle data.
static java.lang.String	INTENT_SNS_NOTIFICATION_FROM Intent Key for GCM bundle.

Constructor Summary

Constructors

Constructor and Description
NotificationClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext) Deprecated. Use createClient(PinpointContext, ChannelType) instead.

Method Summary

Modifier and Type	Method and Description
void	addDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler handler) Add a device token register handler.
void	addGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler) Deprecated. Use addDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler) instead.
boolean	areAppNotificationsEnabled() If app-level opt-out is enabled, this method always returns false.
static NotificationClient	createClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext, ChannelType channelType) Creates a new NotificationClient based on the supplied context and channel type.
java.lang.String	getChannelType() The Pinpoint channel type for the device associated with this notification client.
java.lang.String	getDeviceToken() get the device token.
java.lang.String	getGCMDeviceToken() Deprecated. Use getDeviceToken() instead.
NotificationClient.CampaignPushResult	handleCampaignPush(NotificationDetails notificationDetails) Deprecated. see handleNotificationReceived(NotificationDetails)
NotificationClient.CampaignPushResult	handleFCMCampaignPush(java.lang.String from, java.util.Map<java.lang.String,java.lang.String> data) Deprecated. Use handleCampaignPush(NotificationDetails) instead.
NotificationClient.CampaignPushResult	handleGCMCampaignPush(java.lang.String from, android.os.Bundle data, java.lang.Class<? extends android.app.Service> serviceClass) Deprecated. Use handleCampaignPush(NotificationDetails) instead.
NotificationClient.PushResult	handleNotificationReceived(NotificationDetails notificationDetails) Handles Pinpoint push messages by posting a local notification when the app is in the background, or sending a local broadcast if the app is in the foreground.
void	registerDeviceToken(java.lang.String deviceToken) This method should be called once the device token has been received from the device's messaging api in order to enable being targeted for campaign push notifications.
void	registerDeviceToken(java.lang.String userId, java.lang.String channelId) This method should be called once the user id and channel id has been received from the device's messaging api in order to enable being targeted for campaign push notifications.
void	registerGCMDeviceToken(java.lang.String deviceToken) Deprecated. Use registerDeviceToken(String) instead.
void	removeDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler handler) Remove the device register handler.
void	removeGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler) Deprecated. Use removeDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler) instead.

Methods inherited from class java.lang.Object

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

Field Detail

INTENT_SNS_NOTIFICATION_FROM

public static final java.lang.String INTENT_SNS_NOTIFICATION_FROM

Intent Key for GCM bundle.

See Also:

Constant Field Values

INTENT_SNS_NOTIFICATION_DATA

public static final java.lang.String INTENT_SNS_NOTIFICATION_DATA

Intent Key for GCM bundle data.

See Also:

Constant Field Values

ADM_INTENT_ACTION

public static final java.lang.String ADM_INTENT_ACTION

Intent action for ADM

See Also:

Constant Field Values

BAIDU_INTENT_ACTION

public static final java.lang.String BAIDU_INTENT_ACTION

Intent action for Baidu

See Also:

Constant Field Values

GCM_INTENT_ACTION

public static final java.lang.String GCM_INTENT_ACTION

Intent action for GCM

See Also:

Constant Field Values

FCM_INTENT_ACTION

public static final java.lang.String FCM_INTENT_ACTION

Intent action for FCM

See Also:

Constant Field Values

Constructor Detail

NotificationClient

@Deprecated
public NotificationClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)

Deprecated. Use createClient(PinpointContext, ChannelType) instead.

Constructor.

Parameters:

pinpointContext - the Pinpoint context. PinpointContext

Method Detail

createClient

public static NotificationClient createClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext,
                                              ChannelType channelType)

Creates a new NotificationClient based on the supplied context and channel type. This method returns an instance based on NotificationClient interface.

Parameters:

pinpointContext - Context to associate with the client.

channelType - The channel type the client will support.

Returns:

A new instance of the NotificationClient

addGCMTokenRegisteredHandler

@Deprecated
public void addGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler)

Deprecated. Use addDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler) instead.

Add a GCM token register handler.

Parameters:

handler - the GCM register handler.

removeGCMTokenRegisteredHandler

@Deprecated
public void removeGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler)

Deprecated. Use removeDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler) instead.

Remove the gcm register handler.

Parameters:

handler - the gcm register handler.

registerGCMDeviceToken

@Deprecated
public void registerGCMDeviceToken(java.lang.String deviceToken)

Deprecated. Use registerDeviceToken(String) instead.

This method should be called once the device token has been received from the GCM api in order to enable being targeted for campaign push notifications.

Parameters:

deviceToken - the GCM device token.

getGCMDeviceToken

@Deprecated
public java.lang.String getGCMDeviceToken()

Deprecated. Use getDeviceToken() instead.

get the GCM device token.

Returns:

the GCM device token.

handleFCMCampaignPush

@Deprecated
public NotificationClient.CampaignPushResult handleFCMCampaignPush(java.lang.String from,
                                                                               java.util.Map<java.lang.String,java.lang.String> data)

Deprecated. Use handleCampaignPush(NotificationDetails) instead.

Handles Pinpoint FCM push messages by posting a local notification when the app is in the background, or sending a local broadcast if the app is in the foreground. Also on Api level 19 devices and above, if local notifications have been disabled and the app is in the background, a local broadcast is sent.

Parameters:

from - the from string received by the FCM service,

data - the bundle received from the FCM service

Returns:

NotificationClient.PushResult.

handleGCMCampaignPush

@Deprecated
public NotificationClient.CampaignPushResult handleGCMCampaignPush(java.lang.String from,
                                                                               android.os.Bundle data,
                                                                               java.lang.Class<? extends android.app.Service> serviceClass)

Deprecated. Use handleCampaignPush(NotificationDetails) instead.

Handles Pinpoint GCM push messages by posting a local notification when the app is in the background, or sending a local broadcast if the app is in the foreground. Also on Api level 19 devices and above, if local notifications have been disabled and the app is in the background, a local broadcast is sent.

Parameters:

from - the from string received by the GCM service

data - the bundle received from the GCM service

serviceClass - the class extending GCMListenerService that handles receiving GCM messages.

Returns:

NotificationClient.PushResult.

areAppNotificationsEnabled

public boolean areAppNotificationsEnabled()

If app-level opt-out is enabled, this method always returns false. Otherwise, the following logic applies: On devices using Android API level 19 and above, this method properly returns whether local notifications are enabled for the app. For devices before API level 19, this method always returns true. Disabling notifications was a feature added on devices supporting API Level 16 and above, so devices from API level 16 to 18 will return true from this method even when local notifications have been disabled for the app.

Returns:

true if local notifications are enabled for this app, otherwise false.

addDeviceTokenRegisteredHandler

public final void addDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler handler)

Add a device token register handler.

Parameters:

handler - the devices register handler.

removeDeviceTokenRegisteredHandler

public final void removeDeviceTokenRegisteredHandler(DeviceTokenRegisteredHandler handler)

Remove the device register handler.

Parameters:

handler - the gcm register handler.

registerDeviceToken

public final void registerDeviceToken(java.lang.String deviceToken)

This method should be called once the device token has been received from the device's messaging api in order to enable being targeted for campaign push notifications.

Parameters:

deviceToken - the device token.

registerDeviceToken

public final void registerDeviceToken(java.lang.String userId,
                                      java.lang.String channelId)

This method should be called once the user id and channel id has been received from the device's messaging api in order to enable being targeted for campaign push notifications.

Parameters:

userId - the user id

channelId - the channel id

getDeviceToken

public final java.lang.String getDeviceToken()

get the device token.

Returns:

the device token.

getChannelType

public java.lang.String getChannelType()

The Pinpoint channel type for the device associated with this notification client.

Returns:

Channel type for the device.

handleNotificationReceived

public NotificationClient.PushResult handleNotificationReceived(NotificationDetails notificationDetails)

Handles Pinpoint push messages by posting a local notification when the app is in the background, or sending a local broadcast if the app is in the foreground. Also on Api level 19 devices and above, if local notifications have been disabled and the app is in the background, a local broadcast is sent.

Parameters:

notificationDetails - the notification message received by the device's messaging service

Returns:

NotificationClient.PushResult.

handleCampaignPush

@Deprecated
public NotificationClient.CampaignPushResult handleCampaignPush(NotificationDetails notificationDetails)

Deprecated. see handleNotificationReceived(NotificationDetails)