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

fun BrazeNotificationPayload(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)

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

Properties

var accentColor: Int? = null

val actionButtons: List<BrazeNotificationPayload.ActionButton>

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

var bigImageUrl: String? = null

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

var bigSummaryText: String? = null

var bigTitleText: String? = null

var brazeExtras: Bundle

configurationProvider

var configurationProvider: BrazeConfigurationProvider? = null

contentCardSyncData

var contentCardSyncData: String? = null

contentCardSyncUserId

var contentCardSyncUserId: String? = null

var contentText: String? = null

var context: Context?

conversationMessages

val conversationMessages: List<BrazeNotificationPayload.ConversationMessage>

conversationPersonMap

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

conversationReplyPersonId

var conversationReplyPersonId: String? = null

conversationShortcutId

var conversationShortcutId: String? = null

customNotificationId

var customNotificationId: Int? = null

var deeplink: String? = null

var extras: Map<String, String>

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

isConversationalPush

var isConversationalPush: Boolean = false

isInlineImagePush

var isInlineImagePush: Boolean = false

isNewlyReceivedPushStory

var isNewlyReceivedPushStory: Boolean = false

var isPushStory: Boolean = false

isUninstallTrackingPush

var isUninstallTrackingPush: Boolean = false

var largeIcon: String? = null

notificationBadgeNumber

var notificationBadgeNumber: Int? = null

notificationCategory

var notificationCategory: String? = null

notificationChannelId

var notificationChannelId: String? = null

notificationExtras

val notificationExtras: Bundle

notificationPriorityInt

var notificationPriorityInt: Int? = null

notificationReceivedTimestampMillis

var notificationReceivedTimestampMillis: Long? = null

notificationSound

var notificationSound: String? = null

notificationVisibility

var notificationVisibility: Int? = null

publicNotificationExtras

var publicNotificationExtras: String? = null

var pushDuration: Int? = null

pushStoryPageIndex

var pushStoryPageIndex: Int = 0

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

val pushStoryPages: List<BrazeNotificationPayload.PushStoryPage>

shouldFetchTestTriggers

var shouldFetchTestTriggers: Boolean = false

shouldRefreshFeatureFlags

var shouldRefreshFeatureFlags: Boolean = false

shouldSyncGeofences

var shouldSyncGeofences: Boolean = false

var summaryText: String? = null

var titleText: String? = null