Push Callback 2.x.x

Notification Click Observers

MoEngage plugin triggers the PushNotifCallback event whenever a notification is clicked. This event is a common trigger for both iOS and Android platforms. Refer to the below code to set observer to the same:

using MoEngage;

// Add Push Callback for MoEGameObject
MoEGameObject.PushNotifCallback += PushCallback;

//Implement the calback
public void PushCallback(object sender, PushCampaign campaign)
		Debug.Log(" Event handler callback: " + campaign.platform + " \n payload:" + campaign.payload);

PushCampaign structure

PushCampaign instance will have the below properties:

public class PushCampaign
    public string platform; // ios/android
    public IDictionary<string,object> payload; // notification payload
    public bool isDefaultAction; 
    public IDictionary<string,object> clickedAction;

Payload Structure for clickedAction Dictionary

  "clickedAction": {
    "type": "navigation/customAction",
    "payload": {
      "type": "screenName/deepLink/richLanding",
      "value": "",
      "kvPair": {
        "key1": "value1",
        "key2": "value2",

platform - Native platform from which callback is triggered. Possible values - androidios
isDefaultAction - This key is present only for the Android Platform. It's a boolean value indicating if the user clicked on the default content or not. true if the user clicks on the default content else false.
clickedAction - Action to be performed on notification click.
clickedAction.type - Type of click action. Possible values navigation and customAction. Currently, customAction is supported only on Android.
clickAction.payload - Action payload for the clicked action.
clickedAction.payload.type - Type of navigation action defined. Possible values screenNamedeepLinkrichLanding. Currently, in the case of iOS, richlanding and deep-link URL are processed internally by the SDK and not passed in this callback therefore possible value in case of iOS is only screenName.
clickAction.value - value entered for navigation action or custom payload.
clickAction.kvPair - Custom key-value pair entered on the MoEngage Platform.
payload - Complete campaign payload.

Android Payload

If the user clicks on the default content of the notification the key-value pair and campaign payload can be found inside the payload key. If the user clicks on the action button or a push template action the action payload would be found inside clickedAction.
You can use the isDefaultAction key to check whether the user clicked on the default content or not and then parse the payload accordingly.

iOS Payload

In the case of iOS, you would always receive the key-value pairs with respect to clicked action in clickedAction property. Refer to this link for knowing the iOS notification payload structure.



Was this article helpful?
0 out of 0 found this helpful

How can we improve this article?