Package com.batch.android.eventdispatcher

Class PushEventPayload

java.lang.Object

com.batch.android.eventdispatcher.PushEventPayload

All Implemented Interfaces:

Batch.EventDispatcher.Payload

public class PushEventPayload
extends java.lang.Object
implements Batch.EventDispatcher.Payload

Payload accessor for a Batch.EventDispatcher.Type.NOTIFICATION_DISPLAY or Batch.EventDispatcher.Type.NOTIFICATION_OPEN.

Constructor Summary

Constructors

Constructor	Description
PushEventPayload(BatchPushPayload payload)
PushEventPayload(BatchPushPayload payload, boolean isOpening)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushEventPayload

public PushEventPayload(BatchPushPayload payload)

PushEventPayload

public PushEventPayload(BatchPushPayload payload,
                        boolean isOpening)

Method Detail

getTrackingId

@Nullable
public java.lang.String getTrackingId()

Description copied from interface: Batch.EventDispatcher.Payload

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

Specified by:

getTrackingId in interface Batch.EventDispatcher.Payload

Returns:

the tracking id or null if none is set.

getWebViewAnalyticsID

@Nullable
public java.lang.String getWebViewAnalyticsID()

Description copied from interface: Batch.EventDispatcher.Payload

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.

Specified by:

getWebViewAnalyticsID in interface Batch.EventDispatcher.Payload

Returns:

the button analytics ID or null if none is available.

getDeeplink

@Nullable
public java.lang.String getDeeplink()

Description copied from interface: Batch.EventDispatcher.Payload

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

Specified by:

getDeeplink in interface Batch.EventDispatcher.Payload

Returns:

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

isPositiveAction

public boolean isPositiveAction()

Description copied from interface: Batch.EventDispatcher.Payload

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

Specified by:

isPositiveAction in interface Batch.EventDispatcher.Payload

Returns:

getCustomValue

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

Description copied from interface: Batch.EventDispatcher.Payload

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

Specified by:

getCustomValue in interface Batch.EventDispatcher.Payload

Returns:

the corresponding value or null if none is set.

getMessagingPayload

@Nullable
public BatchMessage getMessagingPayload()

Description copied from interface: Batch.EventDispatcher.Payload

Get the raw payload associated with the event

Specified by:

getMessagingPayload in interface Batch.EventDispatcher.Payload

Returns:

the payload or null if the event is not a message

getPushPayload

@Nullable
public BatchPushPayload getPushPayload()

Description copied from interface: Batch.EventDispatcher.Payload

Get the raw payload associated with the event

Specified by:

getPushPayload in interface Batch.EventDispatcher.Payload

Returns:

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