com.amazonaws.mobileconnectors.pinpoint.targeting.notification

Class NotificationClient

java.lang.Object

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

public class NotificationClient
extends 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 Result values of handling a pinpoint push message.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CAMPAIGN_ACTIVITY_ID_ATTRIBUTE_KEY
protected static String	CAMPAIGN_ACTIVITY_ID_PUSH_KEY
protected static String	CAMPAIGN_ID_ATTRIBUTE_KEY
protected static String	CAMPAIGN_ID_PUSH_KEY
protected static String	CAMPAIGN_PUSH_KEY_PREFIX
protected static String	CAMPAIGN_TREATMENT_ID_ATTRIBUTE_KEY
protected static String	CAMPAIGN_TREATMENT_ID_PUSH_KEY
static String	INTENT_SNS_NOTIFICATION_DATA Intent Key for GCM bundle data.
static String	INTENT_SNS_NOTIFICATION_FROM Intent Key for GCM bundle.
protected static String	PINPOINT_PUSH_KEY_PREFIX

Constructor Summary

Constructors

Constructor and Description
NotificationClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler) Add a GCM token register handler.
boolean	areAppNotificationsEnabled() On devices using Android API level 19 and above this method properly returns whether local notifications are enabled for the app.
String	getGCMDeviceToken() get the GCM device token.
NotificationClient.CampaignPushResult	handleFCMCampaignPush(String from, Map<String,String> data) 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.
NotificationClient.CampaignPushResult	handleGCMCampaignPush(String from, android.os.Bundle data, Class<? extends android.app.Service> serviceClass) 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.
void	registerGCMDeviceToken(String deviceToken) 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.
void	removeGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler) Remove the gcm register handler.

Methods inherited from class java.lang.Object

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

Field Detail

INTENT_SNS_NOTIFICATION_FROM

public static final String INTENT_SNS_NOTIFICATION_FROM

Intent Key for GCM bundle.

See Also:

Constant Field Values

INTENT_SNS_NOTIFICATION_DATA

public static final String INTENT_SNS_NOTIFICATION_DATA

Intent Key for GCM bundle data.

See Also:

Constant Field Values

PINPOINT_PUSH_KEY_PREFIX

protected static final String PINPOINT_PUSH_KEY_PREFIX

See Also:

Constant Field Values

CAMPAIGN_PUSH_KEY_PREFIX

protected static final String CAMPAIGN_PUSH_KEY_PREFIX

See Also:

Constant Field Values

CAMPAIGN_ID_ATTRIBUTE_KEY

protected static final String CAMPAIGN_ID_ATTRIBUTE_KEY

See Also:

Constant Field Values

CAMPAIGN_ID_PUSH_KEY

protected static final String CAMPAIGN_ID_PUSH_KEY

See Also:

Constant Field Values

CAMPAIGN_ACTIVITY_ID_ATTRIBUTE_KEY

protected static final String CAMPAIGN_ACTIVITY_ID_ATTRIBUTE_KEY

See Also:

Constant Field Values

CAMPAIGN_ACTIVITY_ID_PUSH_KEY

protected static final String CAMPAIGN_ACTIVITY_ID_PUSH_KEY

See Also:

Constant Field Values

CAMPAIGN_TREATMENT_ID_ATTRIBUTE_KEY

protected static final String CAMPAIGN_TREATMENT_ID_ATTRIBUTE_KEY

See Also:

Constant Field Values

CAMPAIGN_TREATMENT_ID_PUSH_KEY

protected static final String CAMPAIGN_TREATMENT_ID_PUSH_KEY

See Also:

Constant Field Values

Constructor Detail

NotificationClient

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

Constructor.

Parameters:

pinpointContext - the pinpoint context. PinpointContext

Method Detail

addGCMTokenRegisteredHandler

public void addGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler)

Add a GCM token register handler.

Parameters:

handler - the GCM register handler.

removeGCMTokenRegisteredHandler

public void removeGCMTokenRegisteredHandler(GCMTokenRegisteredHandler handler)

Remove the gcm register handler.

Parameters:

handler - the gcm register handler.

registerGCMDeviceToken

public void registerGCMDeviceToken(String deviceToken)

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

public String getGCMDeviceToken()

get the GCM device token.

Returns:

the GCM device token.

handleFCMCampaignPush

public NotificationClient.CampaignPushResult handleFCMCampaignPush(String from,
                                                                   Map<String,String> data)

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.CampaignPushResult.

handleGCMCampaignPush

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

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.CampaignPushResult.

areAppNotificationsEnabled

public boolean areAppNotificationsEnabled()

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.