Skip to content

Commit 366bc39

Browse files
committed
update docs with feedback from issue avivais#52
1 parent 619f0e8 commit 366bc39

3 files changed

Lines changed: 24 additions & 6 deletions

File tree

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Parse.Push plugin for Cordova/Phonegap/ionic. Works for both hosted Parse.com an
2222
- **getSubscriptions**( successCB, errorCB )
2323
- **subscribe**( channel, successCB, errorCB )
2424
- **unsubscribe**( channel, successCB, errorCB )
25-
- **register( successCB, errorCB ) //optional
25+
- **register**( successCB, errorCB ) //optional, see [Advanced Configuration](#advanced-configuration)
2626

2727
#### Notification events
2828

@@ -128,6 +128,11 @@ Create the following tags in `config.xml`:
128128
<preference name="ParseAppId" value="your-parse-app-id" />
129129
<preference name="ParseServerUrl" value="http://your-parse-server:1337/parse/" />
130130

131+
<!-- if your parse-server config requires a client key, set this.
132+
If not, skip this preference
133+
-->
134+
<preference name="ParseClientKey" value="your-parse-client-key" />
135+
131136
<!-- required for Android push notification
132137
To get your GCM sender ID, enable GCM for your Android project in the Google Developer Console.
133138
The sender id is your project number, and should be a large integer like 123427208255.
@@ -146,9 +151,9 @@ Create the following tags in `config.xml`:
146151
<preference name="ParseServerUrl" value="PARSE_DOT_COM" />
147152
```
148153

149-
You're all set. The plugin takes care of initializing Parse platform using the `config.xml` preferences mentioned above.
150-
To customize push notifications, initialize Parse platform yourself, or use your own `MainApplication.java` in Android,
151-
see the [Advanced Configuration](#advanced-configuration) section.
154+
You're all set. The plugin takes care of initializing Parse platform using the `config.xml` preferences mentioned above. The plugin will also take care of saving your installation to the database.
155+
156+
To customize push notifications, initialize Parse platform yourself, or use your own `MainApplication.java` in Android, see the [Advanced Configuration](#advanced-configuration) section.
152157

153158

154159
## Usage
@@ -303,6 +308,19 @@ skip it's version of Parse initialization and notification setup, that way it wo
303308

304309
## Troubleshooting
305310

311+
#### General:
312+
313+
- Parse uses the term "client key" to specify a key for both Android and iOS. This is different from the Javascript key.
314+
In the javascript portion of your Cordova/Phonegap/Ionic app, use the Javascript key. This has nothing to do with the plugin.
315+
In the `config.xml` preference `ParseClientKey`, use Android and iOS client key. Note that for open source [parse-server](https://github.com/ParsePlatform/parse-server), these keys are optional.
316+
317+
- For legacy [Parse.com](https://parse.com), the appropriate key is required depending on your client platform, e.g.,
318+
Javascript, Android or iOS client, dotNet, REST. For open source [parse-server](https://github.com/ParsePlatform/parse-server),
319+
a key is only required if you have configured your server with it. In the past, our Android users have
320+
reported strange errors in their logcat relating to missing permission declarations. It turns out those error messages were red herrings.
321+
The real problem involved a parse-server that required client keys and a missing `ParseClientKey` preference in `config.xml`.
322+
323+
306324
#### Android:
307325

308326
- If you run into this error during build

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "parse-push-plugin",
3-
"version": "0.9.9",
3+
"version": "1.0.2",
44
"description": "Parse.Push plugin for phonegap/cordova/ionic",
55
"cordova": {
66
"id": "parse-push-plugin",

plugin.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<plugin xmlns="http://www.apache.org/cordova/ns/plugins/1.0" id="parse-push-plugin" version="1.0.1">
3+
<plugin xmlns="http://www.apache.org/cordova/ns/plugins/1.0" id="parse-push-plugin" version="1.0.2">
44
<name>ParsePushPlugin</name>
55
<description>Parse.Push plugin for phonegap/cordova/ionic framework</description>
66
<keywords>cordova,phonegap,ionic framework, parse server, parse push, push notification</keywords>

0 commit comments

Comments
 (0)