com.amazonaws.mobileconnectors.pinpoint.targeting.notification

Class NotificationDetails.NotificationDetailsBuilder

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.targeting.notification.NotificationDetails.NotificationDetailsBuilder

Enclosing class:

NotificationDetails

public static class NotificationDetails.NotificationDetailsBuilder
extends java.lang.Object

Builds a NotificationDetails object from push notification data. The messaging platform the push notification was under should determine which fields to set on the builder. GCM example: new NotificationDetails.builder() .from(from) .bundle(bundle) .serviceClass(serviceClass) .intentAction(NotificationClient.GCM_INTENT_ACTION) .build(); FCM example: new NotificationDetails.builder() .from(from) .mapData(mapData) .intentAction(NotificationClient.FCM_INTENT_ACTION) .build(); ADM example: new NotificationDetails.builder() .intent(intent) .serviceClass(serviceClass) .intentAction(NotificationClient.ADM_INTENT_ACTION) .build(); Baidu example: new NotificationDetails.builder() .message(message) .build()

Constructor Summary

Constructors

Constructor and Description
NotificationDetailsBuilder()

Method Summary

Modifier and Type	Method and Description
NotificationDetails	build() Builds and returns an instance of NotificationDetails.
NotificationDetails.NotificationDetailsBuilder	bundle(android.os.Bundle bundle) The bundle received by the local push notification service.
NotificationDetails.NotificationDetailsBuilder	from(java.lang.String from) The from string received by the local push notification service.
NotificationDetails.NotificationDetailsBuilder	intent(android.content.Intent intent) The intent received by the local push notification service.
NotificationDetails.NotificationDetailsBuilder	intentAction(java.lang.String intentAction) The intent action that identifies the push notification service platform.
NotificationDetails.NotificationDetailsBuilder	mapData(java.util.Map<java.lang.String,java.lang.String> mapData) The mapData received by the local push notification service.
NotificationDetails.NotificationDetailsBuilder	message(java.lang.String message) The message received by the local push notification service.
NotificationDetails.NotificationDetailsBuilder	notificationChannelId(java.lang.String notificationChannelId) The NotificationChannelId needed for the local push notification service in Android Oreo and above.
NotificationDetails.NotificationDetailsBuilder	serviceClass(java.lang.Class<? extends android.app.Service> serviceClass) The Android Service class that received the push notification.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationDetailsBuilder

public NotificationDetailsBuilder()

Method Detail

from

public NotificationDetails.NotificationDetailsBuilder from(java.lang.String from)

The from string received by the local push notification service.

Parameters:

from - the "from" string received by the push notification service.

Returns:

NotificationDetails.NotificationDetailsBuilder

bundle

public NotificationDetails.NotificationDetailsBuilder bundle(android.os.Bundle bundle)

The bundle received by the local push notification service.

Parameters:

bundle - the "bundle" received by the push notification service.

Returns:

NotificationDetails.NotificationDetailsBuilder

serviceClass

public NotificationDetails.NotificationDetailsBuilder serviceClass(java.lang.Class<? extends android.app.Service> serviceClass)

The Android Service class that received the push notification.

Parameters:

serviceClass - Android service class that received the push notification

Returns:

NotificationDetails.NotificationDetailsBuilder

intentAction

public NotificationDetails.NotificationDetailsBuilder intentAction(java.lang.String intentAction)

The intent action that identifies the push notification service platform.

Parameters:

intentAction - the intent action that identifies the push notification service platform

Returns:

NotificationDetails.NotificationDetailsBuilder

mapData

public NotificationDetails.NotificationDetailsBuilder mapData(java.util.Map<java.lang.String,java.lang.String> mapData)

The mapData received by the local push notification service.

Parameters:

mapData - the "mapData" received by the push notification service.

Returns:

NotificationDetails.NotificationDetailsBuilder

intent

public NotificationDetails.NotificationDetailsBuilder intent(android.content.Intent intent)

The intent received by the local push notification service.

Parameters:

intent - the "intent" received by the push notification service.

Returns:

NotificationDetails.NotificationDetailsBuilder

message

public NotificationDetails.NotificationDetailsBuilder message(java.lang.String message)

The message received by the local push notification service.

Parameters:

message - the "message" received by the push notification service.

Returns:

NotificationDetails.NotificationDetailsBuilder

notificationChannelId

public NotificationDetails.NotificationDetailsBuilder notificationChannelId(java.lang.String notificationChannelId)

The NotificationChannelId needed for the local push notification service in Android Oreo and above. In the case that the NotificationChannelId is not provided or the provided channel id is not valid, Pinpoint assigns the notifications to its own NotificationChannel with the id "PINPOINT.NOTIFICATION" and channel name as "Notifications"

Parameters:

notificationChannelId - the notification channel id to be associated with this notification.

Returns:

NotificationDetails.NotificationDetailsBuilder

build

public NotificationDetails build()

Builds and returns an instance of NotificationDetails.

Returns:

NotificationDetails