react-native-pusher-push-notifications

Manage pusher interest subscriptions from within React Native JS

IMPORTANT!!!

This module is intended to complement the setup with Carthage. This module allows that implementation to be accessed directly from React Native JS.

github "pusher/push-notifications-swift" ~> 2.0.0

More information about Pusher Beams and their Swift library, push-notifications-swift, can be found on their Github repo.

There are some issues installing this repo you need to be aware of. More info can be found in issue 65.

Getting started

$ npm install react-native-pusher-push-notifications --save

or yarn

$ yarn add react-native-pusher-push-notifications

Automatic installation

React native link has shown to incorrectly setup projects, so follow the manual instructions below.

Manual installation

iOS

1. In Xcode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
2. Go to node_modules ➜ react-native-pusher-push-notifications and add RNPusherPushNotifications.xcodeproj
3. In Xcode, in the project navigator, select your project. Add libRNPusherPushNotifications.a to your project's Build Phases ➜ Link Binary With Libraries

** DO NOT follow the pusher.com push notification docs that detail modifying the AppDelegate.h/m files! - this package takes care of most of the steps for you**

1. Open AppDelegate.m and add:

    // Add this at the top of AppDelegate.m
    #import "RNPusherPushNotifications.h"

    // Add the following as a new methods to AppDelegate.m
    - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
      NSLog(@"Registered for remote with token: %@", deviceToken);
      [[RNPusherPushNotifications alloc] setDeviceToken:deviceToken];
    }

    - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
      [[RNPusherPushNotifications alloc] handleNotification:userInfo];
    }

    -(void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
      NSLog(@"Remote notification support is unavailable due to error: %@", error.localizedDescription);
    }

Android

Refer to https://docs.pusher.com/beams/reference/android for up-to-date Pusher Beams installation instructions (summarized below):

1. Add the temporary URL to package.json:

"dependencies": {
    "react-native-pusher-push-notifications": "git+http://[email protected]/ZeptInc/react-native-pusher-push-notifications#2.1.0"
}

2. Update android/build.gradle

buildscript {
    // ...
    dependencies {
        // ...
        // Add this line
        classpath 'com.google.gms:google-services:4.0.1'
    }
}    

3. Add this to android/app/build.gradle:

dependencies {
   compile project(':react-native-pusher-push-notifications')
   // ...
   implementation 'com.pusher:push-notifications-android:1.0.2'
}

4. Set up android/app/google-services.json

5. Add RNPusherPushNotificationsPackage to MainApplication.java:

import com.b8ne.RNPusherPushNotifications.RNPusherPushNotificationsPackage;
// ...

protected List<ReactPackage> getPackages() {
  return Arrays.<ReactPackage>asList(	  
    new MainReactPackage(),
    new RNPusherPushNotificationsPackage(), // <--- add this
    // ...
}

7. Add to android/settings.gradle (below rootProject.name)

include ':react-native-pusher-push-notifications'
project(':react-native-pusher-push-notifications').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-pusher-push-notifications/android')

Then from typescript:

import {Platform} from "react-native";
import {PUSHER_BEAMS_INSTANCE_ID} from "react-native-dotenv";
import RNPusherPushNotifications from "react-native-pusher-push-notifications";

const init= (): void => {
    RNPusherPushNotifications.setInstanceId(PUSHER_BEAMS_INSTANCE_ID);

    RNPusherPushNotifications.on("notification", handleNotification);
    RNPusherPushNotifications.setOnSubscriptionsChangedListener(onSubscriptionsChanged);
};

const subscribe = (interest: string): void => {
    console.log(`Subscribing to "${interest}"`);
    RNPusherPushNotifications.subscribe(
        interest,
        (statusCode, response) => {
            console.error(statusCode, response);
        },
        () => {
            console.log(`CALLBACK: Subscribed to ${interest}`);
        }
    );
};

const handleNotification = (notification: any): void => {
    console.log(notification);
    if (Platform.OS === "ios") {
        console.log("CALLBACK: handleNotification (ios)");
    } else {
        console.log("CALLBACK: handleNotification (android)");
        console.log(notification);
    }
};

const onSubscriptionsChanged = (interests: string[]): void => {
    console.log("CALLBACK: onSubscriptionsChanged");
    console.log(interests);
}

Usage

// Import module
import RNPusherPushNotifications from 'react-native-pusher-push-notifications';

// Get your interest
const donutsInterest = 'debug-donuts';

// Initialize notifications
export const init = () => {
  // Set your app key and register for push
  RNPusherPushNotifications.setInstanceId(CONSTANTS.PUSHER_INSTANCE_ID);

  // Init interests after registration
  RNPusherPushNotifications.on('registered', () => {
    subscribe(donutsInterest);
  });

  // Setup notification listeners
  RNPusherPushNotifications.on('notification', handleNotification);
};

// Handle notifications received
const handleNotification = notification => {
  console.log(notification);

  // iOS app specific handling
  if (Platform.OS === 'ios') {
    switch (notification.appState) {
      case 'inactive':
      // inactive: App came in foreground by clicking on notification.
      //           Use notification.userInfo for redirecting to specific view controller
      case 'background':
      // background: App is in background and notification is received.
      //             You can fetch required data here don't do anything with UI
      case 'active':
      // App is foreground and notification is received. Show a alert or something.
      default:
        break;
    } else {
        // console.log("android handled notification...");
    }
  }
};

// Subscribe to an interest
const subscribe = interest => {
  // Note that only Android devices will respond to success/error callbacks
  RNPusherPushNotifications.subscribe(
    interest,
    (statusCode, response) => {
      console.error(statusCode, response);
    },
    () => {
      console.log('Success');
    }
  );
};

// Unsubscribe from an interest
const unsubscribe = interest => {
  RNPusherPushNotifications.unsubscribe(
    interest,
    (statusCode, response) => {
      console.tron.logImportant(statusCode, response);
    },
    () => {
      console.tron.logImportant('Success');
    }
  );
};

iOS only methods

// Set interests
const donutInterests = ['debug-donuts', 'debug-general'];
const setSubscriptions = donutInterests => {
  // Note that only Android devices will respond to success/error callbacks
  RNPusherPushNotifications.setSubscriptions(
    donutInterests,
    (statusCode, response) => {
      console.error(statusCode, response);
    },
    () => {
      console.log('Success');
    }
  );
};

Increment Badge number

The APS data sent to Pusher Beams and then to Apple have an option badge. This will update your apps badge counter to the current number. If you send 1, the badge will show 1. This means you need to handle notification read status in your backend and when pushing update to the current number.

By adding incrementBadge you can increment the badge number without having to deal with your backend.

{
  aps: {
    data: {
      incrementBadge: true
    }
  }
}

Troubleshooting

1. dyld: Library not loaded: @rpath/PushNotifications.framework/PushNotifications Ensure the PushNotifications.framework library is added to General => Embedded Binaries

2. dyld: Library not loaded: @rpath/libswiftCore.dylib Ensure Build Settings => Always Embed Swift Standard Libraries is set to Yes and a valid Development provisioning profile exists on your system.