Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avivais/phonegap-parse-plugin
Phonegap 3.0.0 plugin for Parse.com push service
https://github.com/avivais/phonegap-parse-plugin
Last synced: 4 months ago
JSON representation
Phonegap 3.0.0 plugin for Parse.com push service
- Host: GitHub
- URL: https://github.com/avivais/phonegap-parse-plugin
- Owner: avivais
- Created: 2013-07-22T13:42:46.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-28T18:40:54.000Z (over 8 years ago)
- Last Synced: 2024-08-03T19:09:16.775Z (4 months ago)
- Language: HTML
- Size: 46.9 MB
- Stars: 195
- Watchers: 20
- Forks: 316
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Phonegap Parse.com Plugin
=========================
Phonegap 3.0.0 plugin for Parse.com push service
Using [Parse.com's](http://parse.com) 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
------------
Pick one of these two commands:
```
phonegap local plugin add https://github.com/benjie/phonegap-parse-plugin --variable APP_ID=PARSE_APP_ID --variable CLIENT_KEY=PARSE_CLIENT_KEY
cordova plugin add https://github.com/benjie/phonegap-parse-plugin --variable APP_ID=PARSE_APP_ID --variable CLIENT_KEY=PARSE_CLIENT_KEY
```
Initial Setup
-------------
Once the device is ready, call ```parsePlugin.initialize()```. This will register the device with Parse, you should see this reflected in your Parse control panel. After this runs you probably want to save the installationID somewhere, and perhaps subscribe the user to a few channels. Here is a contrived example.
(Note: When using Windows Phone, clientKey must be your .NET client key from Parse. So you will need to set this based on platform i.e. if( window.device.platform == "Win32NT"))
```
parsePlugin.initialize(appId, clientKey, function() {
parsePlugin.subscribe('SampleChannel', function() {
parsePlugin.getInstallationId(function(id) {
/**
* Now you can construct an object and save it to your own services, or Parse, and corrilate users to parse installations
*
var install_data = {
installation_id: id,
channels: ['SampleChannel']
}
*
*/
}, function(e) {
alert('error');
});
}, function(e) {
alert('error');
});
}, function(e) {
alert('error');
});
```
Usage
-----
```
parsePlugin.initialize(appId, clientKey, function() {
alert('success');
}, function(e) {
alert('error');
});
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');
});
```
Quirks
------
### Android
Parse needs to be initialized once in the `onCreate` method of your application class using the `initializeParseWithApplication` method.
If you don’t have an application class (which is most likely the case for a Cordova app), you can create one using this template:
```java
package my.package.namespace;
import android.app.Application;
import org.apache.cordova.core.ParsePlugin;
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
ParsePlugin.initializeParseWithApplication(this);
}
}
```
And add your application name to `AndroidManifest.xml`:
```xml
...
```
Compatibility
-------------
Phonegap > 3.0.0