Push Callbacks

Netmera SDK sends push, in-app message, and web widget events through callback interfaces. This article shows how to register each callback and handle its events.

All callback interfaces are in the com.netmera.callbacks package.

Interface	Setter	Events
NMPushActionCallbacks	Netmera.setPushActionCallbacks(...)	Push registration, receive, open, dismiss, button click, and carousel selection
NMInAppMessageActionCallbacks	Netmera.setInAppMessageActionCallbacks(...)	In-app message shown, opened, and dismissed
NMWebWidgetCallbacks	Netmera.setWebWidgetCallbacks(...)	Web widget shown, dismissed, deeplink, and URL actions
NMPushPresentationCallbacks	Netmera.setPushPresentationCallbacks(...)	Web view presentation requests

Register callbacks

Register only the callbacks your app needs. Register it in an Application, Activity, Fragment, or another class with the required context.

Each setter replaces the previous instance. Pass null to remove a callback.

Kotlin

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        Netmera.setPushActionCallbacks(MyPushActionCallbacks())
        Netmera.setInAppMessageActionCallbacks(MyInAppMessageActionCallbacks())
        Netmera.setWebWidgetCallbacks(MyWebWidgetCallbacks())
        Netmera.setPushPresentationCallbacks(MyPushPresentationCallbacks(this))

        Netmera.init(NetmeraParams(apiKey = apiKey, providers = listOf(NMFCMProvider())))
    }
}

Java

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        Netmera.setPushActionCallbacks(new MyPushActionCallbacks());
        Netmera.setInAppMessageActionCallbacks(new MyInAppMessageActionCallbacks());
        Netmera.setWebWidgetCallbacks(new MyWebWidgetCallbacks());
        Netmera.setPushPresentationCallbacks(new MyPushPresentationCallbacks(this));

        Netmera.init(new NetmeraParams(apiKey, Collections.singletonList(new NMFCMProvider())));
    }
}

Scope a callback to a screen

Remove screen-scoped callbacks when the screen stops. This prevents the SDK from retaining a destroyed Activity or Fragment.

class CampaignActivity : AppCompatActivity() {

    private val inAppCallbacks = object : NMInAppMessageActionCallbacks {
        override fun onInAppMessageShown(context: Context?, inAppMessage: NetmeraInAppMessage) { /* … */ }
        override fun onInAppMessageOpen(context: Context?, inAppMessage: NetmeraInAppMessage) { /* … */ }
        override fun onInAppMessageDismissed(context: Context?, inAppMessage: NetmeraInAppMessage) { /* … */ }
    }

    override fun onStart() {
        super.onStart()
        Netmera.setInAppMessageActionCallbacks(inAppCallbacks)
    }

    override fun onStop() {
        super.onStop()
        Netmera.setInAppMessageActionCallbacks(null)
    }
}

Avoid Toast messages and other UI side effects in production callbacks. Use them only while testing event delivery.

Implement a push action callback

NMPushActionCallbacks reports the push notification lifecycle. For non-Netmera messages, netmeraPushObject is null and bundle contains the raw payload.

Add the implementation

Kotlin

class MyPushActionCallbacks : NMPushActionCallbacks {

    override fun onPushRegister(
        context: Context?, 
        appSenderId: String?, 
        pushToken: String?
    ) {
        Log.v("sample", "onPushRegister :: $pushToken")
    }

    override fun onPushReceive(
        context: Context?,
        bundle: Bundle?,
        netmeraPushObject: NetmeraPushObject?
    ) {
        // netmeraPushObject is null when the message does not come from Netmera
        Log.v("sample", "onPushReceive")
    }

    override fun onPushOpen(
        context: Context?,
        bundle: Bundle?,
        netmeraPushObject: NetmeraPushObject?
    ) {
        Log.v("sample", "onPushOpen")
    }

    override fun onPushDismiss(
        context: Context?,
        bundle: Bundle?,
        netmeraPushObject: NetmeraPushObject?
    ) {
        Log.v("sample", "onPushDismiss")
    }

    override fun onPushButtonClicked(
        context: Context?,
        bundle: Bundle?,
        netmeraPushObject: NetmeraPushObject?
    ) {
        Log.v("sample", "onPushButtonClicked")
    }

    override fun onCarouselObjectSelected(
        context: Context?,
        bundle: Bundle?,
        netmeraPushObject: NetmeraPushObject?,
        selectedIndex: Int,
        netmeraCarouselObject: NetmeraCarouselObject?
    ) {
        Log.v("sample", "onCarouselObjectSelected :: $selectedIndex")
    }
}

Java

public class MyPushActionCallbacks implements NMPushActionCallbacks {

    @Override
    public void onPushRegister(Context context, String appSenderId, String pushToken) {
        Log.v("sample", "onPushRegister :: " + pushToken);
    }

    @Override
    public void onPushReceive(
        Context context,
        Bundle bundle,
        NetmeraPushObject netmeraPushObject
    ) {
        // netmeraPushObject is null when the message does not come from Netmera
        Log.v("sample", "onPushReceive");
    }

    @Override
    public void onPushOpen(
        Context context,
        Bundle bundle,
        NetmeraPushObject netmeraPushObject
    ) {
        Log.v("sample", "onPushOpen");
    }

    @Override
    public void onPushDismiss(
        Context context,
        Bundle bundle,
        NetmeraPushObject netmeraPushObject
    ) {
        Log.v("sample", "onPushDismiss");
    }

    @Override
    public void onPushButtonClicked(
        Context context,
        Bundle bundle,
        NetmeraPushObject netmeraPushObject
    ) {
        Log.v("sample", "onPushButtonClicked");
    }

    @Override
    public void onCarouselObjectSelected(
        Context context,
        Bundle bundle,
        NetmeraPushObject netmeraPushObject,
        int selectedIndex,
        NetmeraCarouselObject netmeraCarouselObject
    ) {
        Log.v("sample", "onCarouselObjectSelected :: " + selectedIndex);
    }
}

Register the callback:

Kotlin

Netmera.setPushActionCallbacks(MyPushActionCallbacks())

Java

Netmera.setPushActionCallbacks(new MyPushActionCallbacks());

Implement an in-app message callback

NMInAppMessageActionCallbacks reports when an in-app message is shown, opened, or dismissed.

Select the banner style in the Netmera Panel. The pop-up style does not trigger these callbacks.

Kotlin

class MyInAppMessageActionCallbacks : NMInAppMessageActionCallbacks {
    private val TAG = "sample"

    override fun onInAppMessageShown(context: Context?, inAppMessage: NetmeraInAppMessage) {
        Log.i(TAG, "onInAppMessageShown triggered :: ${inAppMessage.id}")
    }

    override fun onInAppMessageOpen(context: Context?, inAppMessage: NetmeraInAppMessage) {
        Log.i(TAG, "onInAppMessageOpen triggered :: ${inAppMessage.id}")
    }

    override fun onInAppMessageDismissed(context: Context?, inAppMessage: NetmeraInAppMessage) {
        Log.i(TAG, "onInAppMessageDismissed triggered :: ${inAppMessage.id}")
    }
}

Java

public class MyInAppMessageActionCallbacks implements NMInAppMessageActionCallbacks {

    private final String TAG = "sample";

    @Override
    public void onInAppMessageShown(Context context, NetmeraInAppMessage inAppMessage) {
        Log.i(TAG, "onInAppMessageShown triggered :: " + inAppMessage.getId());
    }

    @Override
    public void onInAppMessageOpen(Context context, NetmeraInAppMessage inAppMessage) {
        Log.i(TAG, "onInAppMessageOpen triggered :: " + inAppMessage.getId());
    }

    @Override
    public void onInAppMessageDismissed(Context context, NetmeraInAppMessage inAppMessage) {
        Log.i(TAG, "onInAppMessageDismissed triggered :: " + inAppMessage.getId());
    }
}

Register the callback:

Kotlin

Netmera.setInAppMessageActionCallbacks(MyInAppMessageActionCallbacks())

Java

Netmera.setInAppMessageActionCallbacks(new MyInAppMessageActionCallbacks());

Implement a web widget callback

NMWebWidgetCallbacks reports when a web widget is shown or dismissed. It also passes deeplink and URL actions to your app.

Netmera Panel Settings:

• Select the Widget style.

• Select Manage App in Create New Widget for app-managed actions.

• Otherwise, the SDK handles the action and does not call onDeeplinkTriggered or onOpenUrlTriggered.

Kotlin

class MyWebWidgetCallbacks : NMWebWidgetCallbacks {

    override fun onDeeplinkTriggered(deeplink: String) {
        Log.i("NetmeraApp", "Deeplink was triggered and should be handled by app. :: $deeplink")
    }

    override fun onOpenUrlTriggered(url: String) {
        Log.i("NetmeraApp", "OpenUrl was triggered and should be handled by app. :: $url")
    }

    override fun onWebWidgetShown(url: String) {
        Log.i("NetmeraApp", "WebWidget shown :: $url")
    }

    override fun onWebWidgetDismiss(url: String) {
        Log.i("NetmeraApp", "WebWidget dismiss :: $url")
    }
}

Java

public class MyWebWidgetCallbacks implements NMWebWidgetCallbacks {

    @Override
    public void onDeeplinkTriggered(String deeplink) {
        Log.i("NetmeraApp", "Deeplink was triggered and should be handled by app. :: " + deeplink);
    }

    @Override
    public void onOpenUrlTriggered(String url) {
        Log.i("NetmeraApp", "OpenUrl was triggered and should be handled by app. :: " + url);
    }

    @Override
    public void onWebWidgetShown(String url) {
        Log.i("NetmeraApp", "WebWidget shown :: " + url);
    }

    @Override
    public void onWebWidgetDismiss(String url) {
        Log.i("NetmeraApp", "WebWidget dismiss :: " + url);
    }
}

Register the callback:

Kotlin

Netmera.setWebWidgetCallbacks(MyWebWidgetCallbacks())

Java

Netmera.setWebWidgetCallbacks(new MyWebWidgetCallbacks());

Implement a push presentation callback

NMPushPresentationCallbacks controls web content opened by a push. Use it to present web content in your own UI.

• Return true from presentWebView(push) after your app starts presentation. The SDK then skips its default web view.

• Return false to use the SDK's default web view.

• Use closeWebView(push) to dismiss your custom UI after a close request.

For example, instant-show pushes return false below. The SDK presents them. Other pushes open WebViewPopupActivity.

Kotlin

class MyPushPresentationCallbacks(
    private val context: Context
) : NMPushPresentationCallbacks {

    override fun presentWebView(push: NetmeraBasePush): Boolean {
        if (push.isInstantShow) {
            return false
        }

        val intent = Intent(context, WebViewPopupActivity::class.java)
            .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
        context.startActivity(intent)

        return true
    }

    override fun closeWebView(push: NetmeraBasePush) {
        WebViewPopupActivity.finishCurrent()
    }
}

Java

public class MyPushPresentationCallbacks implements NMPushPresentationCallbacks {

    private final Context context;

    public MyPushPresentationCallbacks(Context context) {
        this.context = context;
    }

    @Override
    public boolean presentWebView(NetmeraBasePush push) {
        if (push.isInstantShow()) {
            return false;
        }

        Intent intent = new Intent(context, WebViewPopupActivity.class)
                .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        context.startActivity(intent);

        return true;
    }

    @Override
    public void closeWebView(NetmeraBasePush push) {
        WebViewPopupActivity.finishCurrent();
    }
}

Load the push content

The Activity you open from presentWebView() is responsible for loading the push content into its own WebView. In onCreate(), pass your WebView instance to Netmera.handleWebContent(webView) — the SDK loads the push's HTML content into it.

To display a widget when you only have its URL, use Netmera.displayWidget.

Kotlin

// 1) Register once in Application.onCreate()
Netmera.setPushPresentationCallbacks(object : NMPushPresentationCallbacks {

    override fun presentWebView(push: NetmeraBasePush): Boolean {
        // Returning false lets the SDK show its default widget.
        val intent = Intent(this@MyApplication, CustomWebViewActivity::class.java)
            .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
        startActivity(intent)
        return true // the app is presenting the content
    }

    override fun closeWebView(push: NetmeraBasePush) {
        // The SDK calls this when the "close" action in the content is triggered.
        CustomWebViewActivity.finishCurrent()
    }
})

// 2) Inside CustomWebViewActivity.onCreate()
val webView = findViewById<WebView>(R.id.web_view)
Netmera.handleWebContent(webView) // loads the push content into your WebView

Java

public class WebViewPopupActivity extends AppCompatActivity {

    private static WebViewPopupActivity currentInstance;

    public static void finishCurrent() {
        if (currentInstance != null) {
            currentInstance.finish();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_web_view_popup);
        currentInstance = this;

        WebView webView = findViewById(R.id.web_view);
        Netmera.handleWebContent(webView);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (currentInstance == this) {
            currentInstance = null;
        }
    }
}

Register the callback:

Kotlin

Netmera.setPushPresentationCallbacks(MyPushPresentationCallbacks(this))

Java

Netmera.setPushPresentationCallbacks(new MyPushPresentationCallbacks(this));

After registration, the SDK delivers the selected events to your callback implementations.