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

Link copied to clipboard
fun BrazeNotificationPayload(notificationExtras: Bundle?, brazeExtras: Bundle? = getAttachedBrazeExtras( notificationExtras ), context: Context? = null, configurationProvider: BrazeConfigurationProvider? = null)

Types

Link copied to clipboard
class ActionButton(notificationExtras: Bundle, var actionIndex: Int)
Link copied to clipboard
object Companion
Link copied to clipboard
class ConversationMessage(notificationExtras: Bundle, index: Int)
Link copied to clipboard
class ConversationPerson(notificationExtras: Bundle, index: Int)
Link copied to clipboard
class PushStoryPage(notificationExtras: Bundle, var actionIndex: Int)

Functions

Link copied to clipboard
fun setIsInlineImagePush(isInlineImagePush: Boolean)
Link copied to clipboard
open override fun toString(): String

Properties

Link copied to clipboard
var accentColor: Int? = null
Link copied to clipboard

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

Link copied to clipboard
var bigImageUrl: String? = null

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

Link copied to clipboard
var bigSummaryText: String? = null
Link copied to clipboard
var bigTitleText: String? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var contentText: String? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var deeplink: String? = null
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var isPushStory: Boolean = false
Link copied to clipboard
Link copied to clipboard
var largeIcon: String? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var pushDuration: Int? = null
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var summaryText: String? = null
Link copied to clipboard
var titleText: String? = null