-
public interface Batch.EventDispatcher.PayloadAccessor to the payload of the dispatched event in dispatchEvent.Declared under Batch.EventDispatcher to avoid ambiguity with BatchEventData and BatchPushPayload.
-
-
Method Summary
Modifier and Type Method Description abstract StringgetTrackingId()Get the tracking ID associated with the event. abstract StringgetWebViewAnalyticsID()Get the button analytics ID associated with the event. abstract StringgetDeeplink()Get the deeplink url associated with the event. abstract booleanisPositiveAction()Indicate if the action associated with the event is positive. abstract StringgetCustomValue(@NonNull() String key)Get a value from a key within the custom payload associated with the event. abstract BatchMessagegetMessagingPayload()Get the raw payload associated with the event abstract BatchPushPayloadgetPushPayload()Get the raw payload associated with the event -
-
Method Detail
-
getTrackingId
@Nullable() abstract String getTrackingId()
Get the tracking ID associated with the event.Only set for in-app, see isNotificationEvent.
-
getWebViewAnalyticsID
@Nullable() abstract String getWebViewAnalyticsID()
Get the button analytics ID associated with the event.Only used for messages of types MESSAGING_WEBVIEW_CLICK or MESSAGING_CLOSE.Matches the "analyticsID" parameter of various methods of the JavaScript SDK.
-
getDeeplink
@Nullable() abstract String getDeeplink()
Get the deeplink url associated with the event.Only set for MESSAGING_CLICK, NOTIFICATION_OPEN and NOTIFICATION_DISPLAY
-
isPositiveAction
abstract 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
-
getCustomValue
@Nullable() abstract String getCustomValue(@NonNull() String key)
Get a value from a key within the custom payload associated with the event.
-
getMessagingPayload
@Nullable() abstract BatchMessage getMessagingPayload()
Get the raw payload associated with the event
-
getPushPayload
@Nullable() abstract BatchPushPayload getPushPayload()
Get the raw payload associated with the event
-
-
-
-