Batch Android SDK/com.batch.android/BatchPushPayload

BatchPushPayload

open class BatchPushPayload : PushUserActionSource

Convenience object to retrieve standardized Batch data out of a Batch Push intent. This class does not have a public constructor. You must use payloadFromBundle or payloadFromReceiverIntent

Types

Link copied to clipboard
open class ParsingException : Exception
Represents a payload parsing exception.

Functions

Link copied to clipboard
open fun getActions(): List<BatchNotificationAction>
Get the actions associated with this push, if any.
Link copied to clipboard
open fun getBigPictureURL(context: Context): String
Get the big picture url contained in this push.
Link copied to clipboard
@Nullable
open fun getChannel(): String
Get the desired notification channel.
Link copied to clipboard
open fun getCustomLargeIconURL(context: Context): String
Get the custom large icon url contained in this push.
Link copied to clipboard
open fun getDeeplink(): String
Get the deeplink url contained in this push.
Link copied to clipboard
open fun getGroup(): String
Get the notification group name.
Link copied to clipboard
open fun getLandingMessage(): BatchMessage
Returns the landing message that's in this payload if there is one.
Link copied to clipboard
open fun getPushBundle(): Bundle
Get the raw push bundle
Link copied to clipboard
open fun hasBigPicture(): Boolean
Does this push contains a big picture
Link copied to clipboard
open fun hasCustomLargeIcon(): Boolean
Does this push contains a custom large icon
Link copied to clipboard
open fun hasDeeplink(): Boolean
Does this push contains a deeplink
Link copied to clipboard
open fun hasLandingMessage(): Boolean
Whether the payload contains a landing message or not
Link copied to clipboard
open fun isGroupSummary(): Boolean
Get the notification group name.
Link copied to clipboard
open fun payloadFromBundle(@Nullable bundle: Bundle): BatchPushPayload
Attempt to extract the Batch Push data contained within the specified Bundle.
Link copied to clipboard
open fun payloadFromFirebaseMessage(@NonNull remoteMessage: RemoteMessage): BatchPushPayload
Attempt to extract the Batch Push data contained within the specified Firebase RemoteMessage.
Link copied to clipboard
open fun payloadFromReceiverExtras(@NonNull extras: Bundle): BatchPushPayload
Attempt to extract the Batch Push data contained within the specified Intent extras.
Link copied to clipboard
open fun payloadFromReceiverIntent(@NonNull intent: Intent): BatchPushPayload
Attempt to extract the Batch Push data contained within the specified Intent.
Link copied to clipboard
open fun writeToBundle(@NonNull bundle: Bundle)
Serialize this instance into a Bundle.
Link copied to clipboard
open fun writeToIntentExtras(@NonNull intent: Intent)
Serialize this instance into an Intent.