BatchEventDispatcherPayload

@protocol BatchEventDispatcherPayload

Protocol to access data associated with a dispatched event.

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nullable) NSString *trackingId

  • Undocumented

    Declaration

    Objective-C

    @property (readonly, nullable) NSString *deeplink

  • 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 an in-app campaign

    Declaration

    Objective-C

    @required
@property (atomic, readonly) int isPositiveAction;

  • Get the analytics identifier associated with the event. Only used for messages of type BatchEventDispatcherTypeMessagingWebViewClick and BatchEventDispatcherTypeMessagingClose. Matches the “analyticsID” parameter of various methods of the JavaScript SDK.

    Declaration

    Objective-C

    @required
@property (atomic, readonly, nullable) int *webViewAnalyticsIdentifier;

  • Message that originated this event, if this is a messaging event. Not applicable for notification events.

    Declaration

    Objective-C

    @required
@property (atomic, readonly, nullable) BatchMessage *sourceMessage;

  • UserInfo of the originating remote notification, if this is a notification event.

    Applicable for messaging events if the message is a mobile landing.

    Declaration

    Objective-C

    @required
@property (atomic, readonly, nullable) int *notificationUserInfo;

  • Read a value for a custom payload key

    Declaration

    Objective-C

    - (id)customValueForKey:(id)key;