Migrate from previous version

If you were previously using the now deprecated version of Amplify Push Notifications for React Native (@aws-amplify/pushnotification), you will need to migrate to the new version by following the steps outlined here.

Update your configuration

1. Make sure you are using the latest version of the Amplify CLI.

amplify upgrade

2. Pull your project (even if there are no changes) to update your configuration.

amplify pull

Replace your dependency

1. Remove the old dependency from your project.

npm uninstall @aws-amplify/pushnotification

2. Add the new native module to your project.

npm install @aws-amplify/rtn-push-notification@~1.1.x

Update build configurations

platform :ios, '13.0'

npx pod-install

#import "AppDelegate.h"
#import "AmplifyPushNotification.h"

...

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
  [AmplifyPushNotification didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
  [AmplifyPushNotification didReceiveRemoteNotification:userInfo withCompletionHandler:completionHandler];
}

buildscript {
  ext {
    ...
    minSdkVersion = 24
    ...
  }
}

dependencies {
  ...
-   implementation "com.google.firebase:firebase-core:15.0.2"
-   implementation "com.google.firebase:firebase-messaging:15.0.2"
  ...
}

<application ... >
  ...
- <!--[START Push notification config -->
- <service
-   android:name="com.amazonaws.amplify.pushnotification.RNPushNotificationMessagingService"
-   android:exported="false">
-   <intent-filter>
-     <action android:name="com.google.firebase.MESSAGING_EVENT"/>
-   </intent-filter>
- </service>
- <!-- [END Push notification config -->
  ...
</application>

Update your application code

Add required polyfills

You need to add the crypto.getRandomValues and URL polyfills to your application's entry point file (in most React Native apps this will be the top level index.js).

// Example index.js
import 'react-native-get-random-values';
import 'react-native-url-polyfill/auto';
...

Remove Analytics (Optional)

If you do not use Amplify Analytics in your application but have previously imported it in your code just to implement Amplify Push Notifications, you should be able to remove it now. Analytics is no longer required to be configured in your frontend application to use Amplify Push Notifications.

Replace APIs

Please refer to the Getting started portion of this guide to start learning more about the new Amplify Push Notifications.

A brief mapping of your APIs to their replacements is as follows:

We strongly recommend you take the time to explore all the ways the new version of Amplify Push Notifications are different and all the new features that have been added. This will help you to make the best decision about how to adopt these changes for your unique use cases.