Phonegap Parse.com Plugin

Cordova/Phonegap 3.0.0 plugin for Parse.com push service

Using Parse.com's REST API for push requires the installation id, which isn't available in JS

This plugin exposes the four native Android API push services to JS:

• getInstallationId
• getSubscriptions
• subscribe
• unsubscribe

Installation

cordova plugin add https://github.com/bostondv/phonegap-parse-plugin.git

phonegap local plugin add https://github.com/bostondv/phonegap-parse-plugin.git

Installation Android

You must create an Application class to ensure Parse.initialize() is always called before the service is started.

• Create a file MainApplication.java in platforms/android/src/<your package name>

• Add following contents replacing <MainActivityClass> with the class name of your main CordovaActvity, YOUR_APP_ID and YOUR_CLIENT_KEY with appropriate Parse keys, and <com.example.app> with your package name.

package <com.example.app>

import android.app.Application;
import android.content.Context;

import com.parse.Parse;
import com.parse.ParseInstallation;
import com.parse.PushService;

public class MainApplication extends Application {
	private static MainApplication instance = new MainApplication();

	public MainApplication() {
		instance = this;
	}

	public static Context getContext() {
		return instance;
	}

	@Override
	public void onCreate() {
		super.onCreate();
  	Parse.initialize(this, "YOUR_APP_ID", "YOUR_CLIENT_KEY");
  	PushService.setDefaultPushCallback(this, <MainActivityClass>.class);
  	ParseInstallation.getCurrentInstallation().saveInBackground();
	}
}

• Update AndroidManifest.xml to reference the MainApplication class by adding android:name="you.package.name.MainApplication" to <application>. Replace your.package.name with the name of your applications package.

Usage Android

Use this to get custom data like a story url from your notification

---

Add this to your apps manifest and change com.example to your package name

<receiver android:name="com.example.PushReceiver" android:exported="false">
  <intent-filter>
    <action android:name="com.example.push" />
  </intent-filter>
</receiver>

Drag PushReceiver.java from org.apache.cordova.core to your package

You can change the key from something other than url under PushReceiver.java

if(key.equals("url")){
	ParsePlugin.key = json.getString(key);
}

---

Usage iOS -----

Add this to your AppDelegates didFinishLaunchingWithOptions

[application registerForRemoteNotificationTypes:
                                 UIRemoteNotificationTypeBadge |
                                 UIRemoteNotificationTypeAlert |
                                 UIRemoteNotificationTypeSound];

Use this to get custom data like a story url from your notification

---

Add this import to your AppDelegate

#import "CDVParsePlugin.h"

Add this to your AppDelegates didFinishLaunchingWithOptions

 NSDictionary *notificationPayload = launchOptions[UIApplicationLaunchOptionsRemoteNotificationKey];
    CDVParsePlugin *parsePlugin = [[CDVParsePlugin alloc] init];
    [parsePlugin handleBackgroundNotification:notificationPayload];

You can change the key from something other than url under CDVParsePlugin.m

- (void)handleBackgroundNotification:(NSDictionary *)notification
{
    if ([notification objectForKey:@"url"])
    {
        // do something with job id
        storyURL = [notification objectForKey:@"url"];
    }
}

Notification JSON with custom data

{
    "aps": {
         "badge": 1,
         "alert": "Hello world!",
         "sound": "cat.caf"
    },
    "url": http://example.com
}

---

#### iOS Frameworks used

• AudioToolbox.framework
• CFNetwork.framework
• CoreGraphics.framework
• CoreLocation.framework
• libz.1.1.3.dylib
• MobileCoreServices.framework
• QuartzCore.framework
• Security.framework
• StoreKit.framework
• SystemConfiguration.framework
• Social.framework
• Accounts.framework
• AdSupport.framework
• src/ios/Frameworks/Parse.framework
• src/ios/Frameworks/FacebookSDK.framework

Javascript Functions

<script type="text/javascript>
	var parsePlugin =  = window.parsePlugin;

	parsePlugin.getInstallationId(function(id) {
		alert(id);
	}, function(e) {
		alert('error');
	});

	parsePlugin.getSubscriptions(function(subscriptions) {
		alert(subscriptions);
	}, function(e) {
		alert('error');
	});

	parsePlugin.subscribe('SampleChannel', function() {
		alert('OK');
	}, function(e) {
		alert('error');
	});

	parsePlugin.unsubscribe('SampleChannel', function(msg) {
		alert('OK');
	}, function(e) {
		alert('error');
	});
	// I am using this to get a url from the notification
	parsePlugin.getNotification(function(url) {
		alert(url);
	}, function(e) {
		alert('error');
	});
</script>

Compatibility

Phonegap/cordova > 3.0.0