Package com.batch.android

Interface Batch.EventDispatcher.Payload

All Known Implementing Classes:

MessagingEventPayload, PushEventPayload

Enclosing class:

Batch.EventDispatcher

public static interface Batch.EventDispatcher.Payload

Accessor to the payload of the dispatched event in BatchEventDispatcher.dispatchEvent(Type, Payload). Declared under Batch.EventDispatcher to avoid ambiguity with BatchEventData and BatchPushPayload.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCustomValue(java.lang.String key)	Get a value from a key within the custom payload associated with the event.
java.lang.String	getDeeplink()	Get the deeplink url associated with the event.
BatchMessage	getMessagingPayload()	Get the raw payload associated with the event
BatchPushPayload	getPushPayload()	Get the raw payload associated with the event
java.lang.String	getTrackingId()	Get the tracking ID associated with the event.
java.lang.String	getWebViewAnalyticsID()	Get the button analytics ID associated with the event.
boolean	isPositiveAction()	Indicate if the action associated with the event is positive.

Method Detail

getTrackingId

@Nullable
java.lang.String getTrackingId()

Get the tracking ID associated with the event. Only set for in-app, see Batch.EventDispatcher.Type.isNotificationEvent().

Returns:

the tracking id or null if none is set.

getWebViewAnalyticsID

@Nullable
java.lang.String getWebViewAnalyticsID()

Get the button analytics ID associated with the event. Only used for messages of types Batch.EventDispatcher.Type.MESSAGING_WEBVIEW_CLICK or Batch.EventDispatcher.Type.MESSAGING_CLOSE. Matches the "analyticsID" parameter of various methods of the JavaScript SDK.

Returns:

the button analytics ID or null if none is available.

getDeeplink

@Nullable
java.lang.String getDeeplink()

Get the deeplink url associated with the event. Only set for Batch.EventDispatcher.Type.MESSAGING_CLICK, Batch.EventDispatcher.Type.NOTIFICATION_OPEN and Batch.EventDispatcher.Type.NOTIFICATION_DISPLAY

Returns:

the deeplink for the event or null if none is available.

isPositiveAction

boolean isPositiveAction()

Indicate if the action associated with the event is positive. A positive action is : - An Open for a push campaign - A CTA click or Global tap containing a deeplink or a custom action for a messaging campaign

Returns:

getCustomValue

@Nullable
java.lang.String getCustomValue(@NonNull
                                java.lang.String key)

Get a value from a key within the custom payload associated with the event.

Parameters:

key -

Returns:

the corresponding value or null if none is set.

getMessagingPayload

@Nullable
BatchMessage getMessagingPayload()

Get the raw payload associated with the event

Returns:

the payload or null if the event is not a message

getPushPayload

@Nullable
BatchPushPayload getPushPayload()

Get the raw payload associated with the event

Returns:

the payload or null if the event is not a push notification