App Center Push

Note

If you have integrated Push in earlier versions of the SDK, you can optionally remove Firebase SDK dependencies.

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.

Set up Firebase Cloud Messaging

You need a Google Account and use the Firebase console.

  1. Create a project on the Firebase console.
  2. Go to project settings (the cog icon).
  3. Go to Cloud Messaging tab.
  4. Copy the Server Key. You will need this key as part of the configuration of Push on the App Center portal for your application.
  5. Copy the Sender ID, as you will need it in SDK integration.

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. The App Center SDK is designed with a modular approach – you only need to integrate the services that you're interested in.

  1. Open a Terminal and navigate to the root of your React Native project, then enter the following to add App Center Push to the app:

    npm install appcenter-push --save
    
  2. Link the plugin to the React Native app by using the react-native link command.

    react-native link appcenter-push
    

    Those steps modify your MainApplication.java file, adding AppCenterReactNativePushPackage there.

  3. (Optional) In case you enabled ProGuard in your Android project, please add the following line to your ProGuard configuration file (android/app/proguard-rules.pro):

    -dontwarn com.microsoft.appcenter.push.**
    

    If you haven't enabled or don't use ProGuard, you may skip this step.

Set the Sender ID

The App Center Push SDK requires the Sender ID obtained in the "Prerequisites" section. Look for the onCreate method in the MainApplication.java file and add the following before SoLoader.init:

Push.setSenderId("{Your Sender ID}");
SoLoader.init(this, false);

You also need to add the following import statement to the same file:

import com.microsoft.appcenter.push.Push;

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.

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 when your app starts. A convenient place to do that is at the outer level in the .js file for your root component:

import Push from 'appcenter-push';
import { AppState, Alert } from 'react-native';

class MyApp extends Component {
}

Push.setListener({
  onPushNotificationReceived: function (pushNotification) {
    let message = pushNotification.message;
    let title = pushNotification.title;

    if (message === null || message === undefined) {
      // Android messages received in the background don't include a message. On Android, that fact can be used to
      // check if the message was received in the background or foreground. For iOS the message is always present.
      title = 'Android background';
      message = '<empty>';
    }

    // Custom name/value pairs set in the App Center web portal are in customProperties
    if (pushNotification.customProperties && Object.keys(pushNotification.customProperties).length > 0) {
      message += '\nCustom properties:\n' + JSON.stringify(pushNotification.customProperties);
    }

    if (AppState.currentState === 'active') {
      Alert.alert(title, message);
    }
    else {
      // Sometimes the push callback is received shortly before the app is fully active in the foreground.
      // In this case you'll want to save off the notification info and wait until the app is fully shown
      // in the foreground before displaying any UI. You could use AppState.addEventListener to be notified
      // when the app is fully in the foreground.
    }
  }
});

Custom data in your notifications

You can send optional custom data as part of the push payload. The data will be sent in the key-value format. This custom data can be intercepted in the app through Push SDK callback.

There are few reserved keywords that can be set via custom data. You can customize your notifications by setting custom color, icon or sound.

Note

Android 5.0 and later uses a silhouette (only alpha channel) of your icon for notifications. See Android 5.0 Behavior Changes for details.

Reserved keywords in Android platform

  • color: The notification's icon color, expressed in #rrggbb format. Will be applied only on devices with Android 5.0 and later.
  • icon: The notification's icon. You should specify name of the icon resource. Supports drawable and mipmap types. If this value isn't specified application icon will be used.
  • sound: Add this key when you want the to play a sound when the device receives the notification. Supports default or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/. This is effective only for devices running or targeting an Android version lower than 8. Sound is set by default on Android 8 and user can change notification settings for the group of notifications coming from AppCenter.

Configure notification's default values

You can specify custom defaults for the icon and color that gets applied when it isn't set in the push payload.

The lines below should be added to AndroidManifest.xml inside the application tag:

<!-- Set default notification icon and color. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_notification" />
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/notification" />

If no custom default icon is set and no icon is set in the push payload, AppCenter displays the application icon.

Existing Firebase Analytics users

The 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 a method to enable it by default. To do this, look for the onCreate method in the MainApplication.java file and add the following before SoLoader.init:

Push.enableFirebaseAnalytics(getApplication());
SoLoader.init(this, false);

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.

import Push from 'appcenter-push';

...

await Push.setEnabled(false);      // Disable push
await Push.setEnabled(true);       // Re-enable it

Check if App Center Push is enabled

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

import Push from 'appcenter-push';

...

const pushEnabled = await Push.isEnabled();