Batch Android SDK/com.batch.android/Batch/EventDispatcher/Payload

Payload

interface Payload

Accessor to the payload of the dispatched event in dispatchEvent. Declared under Batch.EventDispatcher to avoid ambiguity with BatchEventAttributes and BatchPushPayload.

Functions

Link copied to clipboard
@Nullable
abstract fun getCustomValue(@NonNull key: String): String
Get a value from a key within the custom payload associated with the event.
Link copied to clipboard
@Nullable
abstract fun getDeeplink(): String
Get the deeplink url associated with the event.
Link copied to clipboard
@Nullable
abstract fun getMessagingPayload(): BatchMessage
Get the raw payload associated with the event
Link copied to clipboard
@Nullable
abstract fun getPushPayload(): BatchPushPayload
Get the raw payload associated with the event
Link copied to clipboard
@Nullable
abstract fun getTrackingId(): String
Get the tracking ID associated with the event.
Link copied to clipboard
@Nullable
abstract fun getWebViewAnalyticsID(): String
Get the button analytics ID associated with the event.
Link copied to clipboard
abstract fun isPositiveAction(): Boolean
Indicate if the action associated with the event is positive.