App Center Push

App Center Push enables you to send push notifications to users of your app from the App Center portal. App Center portal and the Push SDK is integrated with Firebase Cloud Messaging.

Note that only devices having the Google Play store application or emulators with Google APIs images can receive the notifications.

Note

A notification appears in the system notification center only if the application is in the background at the moment the Push is received.

Prerequisites

1. Connect your app to Firebase

Before using App Center Push service, you need to connect your application to Firebase. Please learn about Prerequisites.

2. Obtain your Android API Key and Sender ID

In the Firebase Console, go to Project Settings. Navigate to the Cloud Messaging tab. Copy the Server Key. This will be the Android API Key that you will need to set in the App Center Push portal. Also make a note of the Sender ID, as you will need it later.

Add App Center Push to your app

Please follow the Get started section if you haven't set up and started the SDK in your application, yet.

1. Add the App Center Push module

The App Center SDK is designed with a modular approach – a developer only needs to integrate the modules of the services that they're interested in.

  1. Open your app level build.gradle file (app/build.gradle) and add the following lines after apply plugin. Include the dependencies that you want in your project. Each SDK module needs to be added as a separate dependency in this section. For integrating the Push module, add the following lines:

    dependencies {
       def appCenterSdkVersion = '1.1.0'
       compile "com.microsoft.appcenter:appcenter-push:${appCenterSdkVersion}"
    }
    
  2. Make sure to trigger a Gradle sync in Android Studio.

2. Start App Center Push

In order to use App Center, you need to opt in to the module(s) that you want to use, meaning by default no modules are started and you will have to explicitly call each of them when starting the SDK.

Add Push.class to your AppCenter.start() method to start App Center Push service. You must set the Sender ID before calling AppCenter.start().

Push.setSenderId("{Your Sender ID}");
AppCenter.start(getApplication(), "{Your App Secret}", Push.class);

Make sure you have replaced {Your App Secret} in the code sample above with your App Secret. Also make sure that you have replaced {Your Sender ID} with the Sender ID obtained in the "Prerequisites" section. Please check out the Get started section if you haven't set up and started the SDK in your application, yet.

Android Studio will automatically suggest the required import statement once you add Push.class to the start() method, but if you see an error that the class names are not recognized, add the following lines to the import statements in your activity class:

import com.microsoft.appcenter.AppCenter;
import com.microsoft.appcenter.push.Push;

Intercept push notifications

You can set up a listener to be notified whenever a push notification is received in foreground or a background push notification has been clicked by the user.

Note

A notification is not generated when your application receives a push in the foreground.

Note

If the push is received in background, the event is NOT triggered at receive time. The event is triggered when you click on the notification.

Note

The background notification click callback does NOT expose title and message. Title and message are only available in foreground pushes.

You need to register the listener before calling AppCenter.start as shown in the following example:

Push.setListener(new MyPushListener());
AppCenter.start(...);

If (and only if) your launcher activity uses a launchMode of singleTop, singleInstance or singleTask, you need to add this in the activity onNewIntent method:

    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);
        Push.checkLaunchedFromNotification(this, intent);
    }

Here is an example of the listener implementation that displays an alert dialog if the message is received in foreground or a toast if a background push has been clicked:

public class MyPushListener implements PushListener {

    @Override
    public void onPushNotificationReceived(Activity activity, PushNotification pushNotification) {

        /* The following notification properties are available. */
        String title = pushNotification.getTitle();
        String message = pushNotification.getMessage();
        Map<String, String> customData = pushNotification.getCustomData();

        /*
         * Message and title cannot be read from a background notification object.
         * Message being a mandatory field, you can use that to check foreground vs background.
         */
        if (message != null) {

            /* Display an alert for foreground push. */
            AlertDialog.Builder dialog = new AlertDialog.Builder(activity);
            if (title != null) {
                dialog.setTitle(title);
            }
            dialog.setMessage(message);
            if (!customData.isEmpty()) {
                dialog.setMessage(message + "\n" + customData);
            }
            dialog.setPositiveButton(android.R.string.ok, null);
            dialog.show();
        } else {

            /* Display a toast when a background push is clicked. */
            Toast.makeText(activity, String.format(activity.getString(R.string.push_toast), customData), Toast.LENGTH_LONG).show(); // For example R.string.push_toast would be "Push clicked with data=%1s"
        }
    }
});

Existing Firebase Analytics users

App Center Push SDK automatically disables Firebase Analytics. If you are a Firebase customer and want to keep reporting analytics data to Firebase, you need to call the following method before AppCenter.start:

Push.enableFirebaseAnalytics(getApplication());
AppCenter.start(getApplication(), "{Your App Secret}", Push.class);

Enable or disable App Center Push at runtime

You can enable and disable App Center Push at runtime. If you disable it, the SDK will stop updating the Google registration identifier used to push but the existing one will continue working. In other words, disabling the App Center Push in the SDK will NOT stop your application from receiving push notifications.

Push.setEnabled(false);

To enable App Center Push again, use the same API but pass true as a parameter.

Push.setEnabled(true);

This API is asynchronous, you can read more about that in our App Center Asynchronous APIs guide.

Check if App Center Push is enabled

You can also check if App Center Push is enabled or not:

Push.isEnabled();

This API is asynchronous, you can read more about that in our App Center Asynchronous APIs guide.