braze-android-sdk/com.braze.models.push/BrazeNotificationPayload

BrazeNotificationPayload

class BrazeNotificationPayload @JvmOverloads constructor(notificationExtras: Bundle?, brazeExtras: Bundle? = getAttachedBrazeExtras( notificationExtras ), context: Context? = null, var configurationProvider: BrazeConfigurationProvider? = null)

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.

Constructors

BrazeNotificationPayload

constructor(notificationExtras: Bundle?, brazeExtras: Bundle? = getAttachedBrazeExtras( notificationExtras ), context: Context? = null, configurationProvider: BrazeConfigurationProvider? = null)

Types

class ActionButton(notificationExtras: Bundle, var actionIndex: Int)

object Companion

ConversationMessage

class ConversationMessage(notificationExtras: Bundle, index: Int)

ConversationPerson

class ConversationPerson(notificationExtras: Bundle, index: Int)

class PushStoryPage(notificationExtras: Bundle, var actionIndex: Int)

Properties

var accentColor: Int?

val actionButtons: List<BrazeNotificationPayload.ActionButton>

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

var bigImageUrl: String?

Equivalent to Constants.BRAZE_PUSH_BIG_IMAGE_URL_KEY in the "brazeExtras" bundle.

var bigSummaryText: String?

var bigTitleText: String?

var brazeExtras: Bundle

var campaignId: String?

configurationProvider

var configurationProvider: BrazeConfigurationProvider?

contentCardSyncData

var contentCardSyncData: String?

contentCardSyncUserId

var contentCardSyncUserId: String?

var contentText: String?

var context: Context?

conversationMessages

val conversationMessages: List<BrazeNotificationPayload.ConversationMessage>

conversationPersonMap

val conversationPersonMap: Map<String?, BrazeNotificationPayload.ConversationPerson>

conversationReplyPersonId

var conversationReplyPersonId: String?

conversationShortcutId

var conversationShortcutId: String?

customNotificationId

var customNotificationId: Int?

var deeplink: String?

var extras: Map<String, String>

The extras on this push notification as a map of key value pairs.

flushMaxMinutes

var flushMaxMinutes: Long

flushMinMinutes

var flushMinMinutes: Long

isConversationalPush

var isConversationalPush: Boolean

isInlineImagePush

var isInlineImagePush: Boolean

isNewlyReceivedPushStory

var isNewlyReceivedPushStory: Boolean

isPushDeliveryEnabled

var isPushDeliveryEnabled: Boolean

var isPushStory: Boolean

val isSilentPush: Boolean

True if push notification is a silent push, false if not.

isUninstallTrackingPush

var isUninstallTrackingPush: Boolean

Returns true if the message is a push notification sent from Braze for uninstall tracking. Uninstall tracking push can be ignored.

var largeIcon: String?

notificationBadgeNumber

var notificationBadgeNumber: Int?

notificationCategory

var notificationCategory: String?

notificationChannelId

var notificationChannelId: String?

notificationExtras

val notificationExtras: Bundle

notificationPriorityInt

var notificationPriorityInt: Int?

notificationReceivedTimestampMillis

var notificationReceivedTimestampMillis: Long?

notificationSound

var notificationSound: String?

notificationVisibility

var notificationVisibility: Int?

publicNotificationExtras

var publicNotificationExtras: String?

var pushDuration: Int?

pushStoryPageIndex

var pushStoryPageIndex: Int

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

val pushStoryPages: List<BrazeNotificationPayload.PushStoryPage>

var pushUniqueId: String?

shouldFetchTestTriggers

var shouldFetchTestTriggers: Boolean

shouldRefreshBanners

var shouldRefreshBanners: Boolean

shouldRefreshFeatureFlags

var shouldRefreshFeatureFlags: Boolean

var summaryText: String?

var titleText: String?

var useWebView: Boolean?

Functions

setActionButtons

fun setActionButtons(actionButtons: MutableList<BrazeNotificationPayload.ActionButton>)

setIsInlineImagePush

fun setIsInlineImagePush(isInlineImagePush: Boolean)

setPushStoryPages

fun setPushStoryPages(pushStoryPages: MutableList<BrazeNotificationPayload.PushStoryPage>)

open override fun toString(): String