com.appboy.models.push

Class BrazeNotificationPayload

java.lang.Object

com.appboy.models.push.BrazeNotificationPayload

public class BrazeNotificationPayload
extends java.lang.Object

A convenience class for parsing the Braze Notification payload. Values are not lazy-loaded and are computed from the input arguments on each constructor call.

Null return values for methods, such as on getCustomNotificationId() are the result of that key either not existing in the original push payload or not being in the proper expected format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrazeNotificationPayload.ActionButton
static class	BrazeNotificationPayload.ConversationMessage
static class	BrazeNotificationPayload.ConversationPerson
static class	BrazeNotificationPayload.PushStoryPage

Constructor Summary

Constructors

Constructor and Description
BrazeNotificationPayload(AppboyConfigurationProvider configurationProvider, android.os.Bundle notificationExtras) Deprecated. Please use BrazeNotificationPayload(BrazeConfigurationProvider, Bundle) instead. Deprecated since 3/25/21
BrazeNotificationPayload(BrazeConfigurationProvider configurationProvider, android.os.Bundle notificationExtras)
BrazeNotificationPayload(android.os.Bundle notificationExtras)
BrazeNotificationPayload(android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Constructor for when using a modified "appboyExtras" bundle
BrazeNotificationPayload(android.content.Context context, AppboyConfigurationProvider configurationProvider, android.os.Bundle notificationExtras) Deprecated.
BrazeNotificationPayload(android.content.Context context, AppboyConfigurationProvider configurationProvider, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras) Deprecated.
BrazeNotificationPayload(android.content.Context context, BrazeConfigurationProvider configurationProvider, android.os.Bundle notificationExtras)
BrazeNotificationPayload(android.content.Context context, BrazeConfigurationProvider configurationProvider, android.os.Bundle notificationExtras, android.os.Bundle appboyExtras)
BrazeNotificationPayload(android.content.Context context, android.os.Bundle notificationExtras)

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getAccentColor()
java.util.List<BrazeNotificationPayload.ActionButton>	getActionButtons()
AppboyConfigurationProvider	getAppboyConfigurationProvider() Deprecated. Please use getConfigurationProvider() instead. Deprecated since 3/25/21
android.os.Bundle	getAppboyExtras()
static android.os.Bundle	getAttachedAppboyExtras(android.os.Bundle notificationExtras) Get the extras Bundle from the notification extras or an empty bundle.
java.lang.String	getBigImageUrl()
java.lang.String	getBigSummaryText()
java.lang.String	getBigTitleText()
BrazeConfigurationProvider	getConfigurationProvider()
java.lang.String	getContentCardSyncData()
java.lang.String	getContentCardSyncUserId()
java.lang.String	getContentText()
android.content.Context	getContext()
java.util.List<BrazeNotificationPayload.ConversationMessage>	getConversationMessages()
java.util.Map<java.lang.String,BrazeNotificationPayload.ConversationPerson>	getConversationPersonMap()
java.lang.String	getConversationReplyPersonId()
java.lang.String	getConversationShortcutId()
java.lang.Integer	getCustomNotificationId()
java.lang.String	getLargeIcon()
java.lang.Integer	getNotificationBadgeNumber()
java.lang.String	getNotificationCategory()
java.lang.String	getNotificationChannelId()
android.os.Bundle	getNotificationExtras()
java.lang.Long	getNotificationReceivedTimestampMillis()
java.lang.String	getNotificationSound()
java.lang.Integer	getNotificationVisibility()
java.lang.String	getPublicNotificationExtras()
java.lang.Integer	getPushDuration()
static int	getPushStoryGravityAtIndex(int actionIndex, android.os.Bundle notificationExtras, java.lang.String actionFieldKeyTemplate)
int	getPushStoryPageIndex()
java.util.List<BrazeNotificationPayload.PushStoryPage>	getPushStoryPages()
java.lang.String	getSummaryText()
static java.lang.String	getTemplateFieldAtIndex(int index, android.os.Bundle notificationExtras, java.lang.String actionFieldKeyTemplate) Returns the value for the given template field key at the specified index.
static boolean	getTemplateFieldAtIndex(int actionIndex, android.os.Bundle notificationExtras, java.lang.String actionFieldKeyTemplate, boolean defaultValue) Returns the boolean value for the given template field key at the specified index.
static long	getTemplateFieldAtIndex(int actionIndex, android.os.Bundle notificationExtras, java.lang.String actionFieldKeyTemplate, long defaultValue) Returns the boolean value for the given template field key at the specified index.
static java.lang.String	getTemplateFieldAtIndex(int index, android.os.Bundle notificationExtras, java.lang.String actionFieldKeyTemplate, java.lang.String defaultValue) Returns the value for the given template field key at the specified index.
java.lang.String	getTitleText()
boolean	isConversationalPush()
boolean	isInlineImagePush()
boolean	isPushStory()
void	setAccentColor(java.lang.Integer accentColor)
void	setActionButtons(java.util.List<BrazeNotificationPayload.ActionButton> actionButtons)
void	setAppboyConfigurationProvider(AppboyConfigurationProvider appboyConfigurationProvider) Deprecated. Please use setConfigurationProvider(BrazeConfigurationProvider) instead. Deprecated since 3/25/21
void	setAppboyExtras(android.os.Bundle appboyExtras)
void	setBigImageUrl(java.lang.String bigImageUrl) Equivalent to setting Constants.APPBOY_PUSH_BIG_IMAGE_URL_KEY in the "appboyExtras" bundle.
void	setBigSummaryText(java.lang.String bigSummaryText)
void	setBigTitleText(java.lang.String bigTitleText)
void	setConfigurationProvider(BrazeConfigurationProvider configurationProvider)
void	setContentCardSyncData(java.lang.String contentCardSyncData)
void	setContentCardSyncUserId(java.lang.String contentCardSyncUserId)
void	setContentText(java.lang.String content)
void	setContext(android.content.Context context)
void	setConversationalPush(boolean conversationalPush)
void	setConversationShortcutId(java.lang.String conversationShortcutId)
void	setCustomNotificationId(java.lang.Integer customNotificationId)
void	setInlineImagePush(boolean inlineImagePush)
void	setIsInlineImagePush(boolean isInlineImagePush)
void	setLargeIcon(java.lang.String largeIcon)
void	setNotificationBadgeNumber(java.lang.Integer notificationBadgeNumber)
void	setNotificationCategory(java.lang.String notificationCategory)
void	setNotificationChannelId(java.lang.String notificationChannelId)
void	setNotificationReceivedTimestampMillis(java.lang.Long notificationReceivedTimestampMillis)
void	setNotificationSound(java.lang.String notificationSound)
void	setNotificationVisibility(java.lang.Integer notificationVisibility)
void	setPublicNotificationExtras(java.lang.String publicNotificationExtras)
void	setPushDuration(java.lang.Integer pushDuration)
void	setPushStory(boolean pushStory)
void	setPushStoryPageIndex(int pushStoryPageIndex)
void	setPushStoryPages(java.util.List<BrazeNotificationPayload.PushStoryPage> pushStoryPages)
void	setSummaryText(java.lang.String summaryText)
void	setTitleText(java.lang.String title)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrazeNotificationPayload

@Deprecated
public BrazeNotificationPayload(AppboyConfigurationProvider configurationProvider,
                                            android.os.Bundle notificationExtras)

Deprecated. Please use BrazeNotificationPayload(BrazeConfigurationProvider, Bundle) instead. Deprecated since 3/25/21

BrazeNotificationPayload

public BrazeNotificationPayload(BrazeConfigurationProvider configurationProvider,
                                android.os.Bundle notificationExtras)

BrazeNotificationPayload

public BrazeNotificationPayload(android.content.Context context,
                                android.os.Bundle notificationExtras)

BrazeNotificationPayload

@Deprecated
public BrazeNotificationPayload(android.content.Context context,
                                            AppboyConfigurationProvider configurationProvider,
                                            android.os.Bundle notificationExtras)

Deprecated.

BrazeNotificationPayload

public BrazeNotificationPayload(android.content.Context context,
                                BrazeConfigurationProvider configurationProvider,
                                android.os.Bundle notificationExtras)

BrazeNotificationPayload

@Deprecated
public BrazeNotificationPayload(android.content.Context context,
                                            AppboyConfigurationProvider configurationProvider,
                                            android.os.Bundle notificationExtras,
                                            android.os.Bundle appboyExtras)

Deprecated.

BrazeNotificationPayload

public BrazeNotificationPayload(android.content.Context context,
                                BrazeConfigurationProvider configurationProvider,
                                android.os.Bundle notificationExtras,
                                android.os.Bundle appboyExtras)

BrazeNotificationPayload

public BrazeNotificationPayload(android.os.Bundle notificationExtras)

BrazeNotificationPayload

public BrazeNotificationPayload(android.os.Bundle notificationExtras,
                                android.os.Bundle appboyExtras)

Constructor for when using a modified "appboyExtras" bundle

Method Detail

getPushStoryPageIndex

public int getPushStoryPageIndex()

Returns:

The current push story page index, or 0 if this field is unspecified in the source bundle.

setPushStoryPageIndex

public void setPushStoryPageIndex(int pushStoryPageIndex)

getNotificationExtras

public android.os.Bundle getNotificationExtras()

getContext

public android.content.Context getContext()

getAppboyConfigurationProvider

@Deprecated
public AppboyConfigurationProvider getAppboyConfigurationProvider()

Deprecated. Please use getConfigurationProvider() instead. Deprecated since 3/25/21

getConfigurationProvider

public BrazeConfigurationProvider getConfigurationProvider()

getAppboyExtras

public android.os.Bundle getAppboyExtras()

getTitleText

public java.lang.String getTitleText()

getPushDuration

public java.lang.Integer getPushDuration()

getContentCardSyncData

public java.lang.String getContentCardSyncData()

getContentCardSyncUserId

public java.lang.String getContentCardSyncUserId()

getNotificationSound

public java.lang.String getNotificationSound()

getNotificationChannelId

public java.lang.String getNotificationChannelId()

getContentText

public java.lang.String getContentText()

isPushStory

public boolean isPushStory()

getLargeIcon

public java.lang.String getLargeIcon()

getSummaryText

public java.lang.String getSummaryText()

getAccentColor

public java.lang.Integer getAccentColor()

getNotificationCategory

public java.lang.String getNotificationCategory()

getNotificationVisibility

public java.lang.Integer getNotificationVisibility()

getNotificationBadgeNumber

public java.lang.Integer getNotificationBadgeNumber()

getPublicNotificationExtras

public java.lang.String getPublicNotificationExtras()

getBigSummaryText

public java.lang.String getBigSummaryText()

getBigTitleText

public java.lang.String getBigTitleText()

getBigImageUrl

public java.lang.String getBigImageUrl()

getCustomNotificationId

public java.lang.Integer getCustomNotificationId()

getNotificationReceivedTimestampMillis

public java.lang.Long getNotificationReceivedTimestampMillis()

getActionButtons

public java.util.List<BrazeNotificationPayload.ActionButton> getActionButtons()

Returns:

The parsed action buttons. If no actions buttons are present, this list will be empty.

isConversationalPush

public boolean isConversationalPush()

getConversationReplyPersonId

public java.lang.String getConversationReplyPersonId()

getConversationMessages

public java.util.List<BrazeNotificationPayload.ConversationMessage> getConversationMessages()

getConversationPersonMap

public java.util.Map<java.lang.String,BrazeNotificationPayload.ConversationPerson> getConversationPersonMap()

getConversationShortcutId

public java.lang.String getConversationShortcutId()

setInlineImagePush

public void setInlineImagePush(boolean inlineImagePush)

setConversationalPush

public void setConversationalPush(boolean conversationalPush)

setConversationShortcutId

public void setConversationShortcutId(java.lang.String conversationShortcutId)

setActionButtons

public void setActionButtons(java.util.List<BrazeNotificationPayload.ActionButton> actionButtons)

getPushStoryPages

public java.util.List<BrazeNotificationPayload.PushStoryPage> getPushStoryPages()

setPushStoryPages

public void setPushStoryPages(java.util.List<BrazeNotificationPayload.PushStoryPage> pushStoryPages)

isInlineImagePush

public boolean isInlineImagePush()

setIsInlineImagePush

public void setIsInlineImagePush(boolean isInlineImagePush)

setNotificationReceivedTimestampMillis

public void setNotificationReceivedTimestampMillis(java.lang.Long notificationReceivedTimestampMillis)

setCustomNotificationId

public void setCustomNotificationId(java.lang.Integer customNotificationId)

setBigImageUrl

public void setBigImageUrl(java.lang.String bigImageUrl)

Equivalent to setting Constants.APPBOY_PUSH_BIG_IMAGE_URL_KEY in the "appboyExtras" bundle.

Parameters:

bigImageUrl - Url of expanded big image.

setAppboyExtras

public void setAppboyExtras(android.os.Bundle appboyExtras)

setContext

public void setContext(android.content.Context context)

setAppboyConfigurationProvider

@Deprecated
public void setAppboyConfigurationProvider(AppboyConfigurationProvider appboyConfigurationProvider)

Deprecated. Please use setConfigurationProvider(BrazeConfigurationProvider) instead. Deprecated since 3/25/21

setConfigurationProvider

public void setConfigurationProvider(BrazeConfigurationProvider configurationProvider)

setPushDuration

public void setPushDuration(java.lang.Integer pushDuration)

setPushStory

public void setPushStory(boolean pushStory)

setPublicNotificationExtras

public void setPublicNotificationExtras(java.lang.String publicNotificationExtras)

setNotificationChannelId

public void setNotificationChannelId(java.lang.String notificationChannelId)

setNotificationCategory

public void setNotificationCategory(java.lang.String notificationCategory)

setNotificationVisibility

public void setNotificationVisibility(java.lang.Integer notificationVisibility)

setNotificationBadgeNumber

public void setNotificationBadgeNumber(java.lang.Integer notificationBadgeNumber)

setContentCardSyncData

public void setContentCardSyncData(java.lang.String contentCardSyncData)

setContentCardSyncUserId

public void setContentCardSyncUserId(java.lang.String contentCardSyncUserId)

setTitleText

public void setTitleText(java.lang.String title)

setContentText

public void setContentText(java.lang.String content)

setLargeIcon

public void setLargeIcon(java.lang.String largeIcon)

setNotificationSound

public void setNotificationSound(java.lang.String notificationSound)

setSummaryText

public void setSummaryText(java.lang.String summaryText)

setAccentColor

public void setAccentColor(java.lang.Integer accentColor)

setBigSummaryText

public void setBigSummaryText(java.lang.String bigSummaryText)

setBigTitleText

public void setBigTitleText(java.lang.String bigTitleText)

getAttachedAppboyExtras

public static android.os.Bundle getAttachedAppboyExtras(android.os.Bundle notificationExtras)

Get the extras Bundle from the notification extras or an empty bundle.

Parameters:

notificationExtras - Notification extras.

Returns:

Returns the Braze extras Bundle from the notification extras. Amazon ADM recursively flattens all JSON messages, so for Amazon devices we just return a copy of the original bundle.

getTemplateFieldAtIndex

public static java.lang.String getTemplateFieldAtIndex(int index,
                                                       android.os.Bundle notificationExtras,
                                                       java.lang.String actionFieldKeyTemplate)

Returns the value for the given template field key at the specified index.

Parameters:

index - the index of the desired template

notificationExtras - Notification bundle containing the data

actionFieldKeyTemplate - the template of the action field

Returns:

the desired notification action field value or the empty string if not present

getTemplateFieldAtIndex

public static java.lang.String getTemplateFieldAtIndex(int index,
                                                       android.os.Bundle notificationExtras,
                                                       java.lang.String actionFieldKeyTemplate,
                                                       java.lang.String defaultValue)

Returns the value for the given template field key at the specified index.

Parameters:

index - the index of the desired template

notificationExtras - Notification bundle containing the data

actionFieldKeyTemplate - the template of the action field

defaultValue - the default value to return if the value for the key in notificationExtras is null.

Returns:

the desired notification action field value or the empty string if not present

getTemplateFieldAtIndex

public static boolean getTemplateFieldAtIndex(int actionIndex,
                                              android.os.Bundle notificationExtras,
                                              java.lang.String actionFieldKeyTemplate,
                                              boolean defaultValue)

Returns the boolean value for the given template field key at the specified index.

Parameters:

actionIndex - the index of the desired template

notificationExtras - Notification bundle containing the data

actionFieldKeyTemplate - the template of the action field

defaultValue - the default value to return if the value for the key in notificationExtras is null or can't be parsed as a boolean.

Returns:

the desired notification action field value or the empty string if not present

getTemplateFieldAtIndex

public static long getTemplateFieldAtIndex(int actionIndex,
                                           android.os.Bundle notificationExtras,
                                           java.lang.String actionFieldKeyTemplate,
                                           long defaultValue)

Returns the boolean value for the given template field key at the specified index.

Parameters:

actionIndex - the index of the desired template

notificationExtras - Notification bundle containing the data

actionFieldKeyTemplate - the template of the action field

defaultValue - the default value to return if the value for the key in notificationExtras is null or can't be parsed as a long.

Returns:

the desired notification action field value or the empty string if not present

getPushStoryGravityAtIndex

public static int getPushStoryGravityAtIndex(int actionIndex,
                                             android.os.Bundle notificationExtras,
                                             java.lang.String actionFieldKeyTemplate)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object