github/jpush-phonegap-plugin
github/jpush-phonegap-plugin
4
0
Fork 1
mirror of https://github.com/jpush/jpush-phonegap-plugin.git synced 2025-03-16 05:51:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

format doc

Browse Source
This commit is contained in:
Hevin 2016-04-22 11:22:07 +08:00
parent 706f32a972
commit 8241b364cc
2 changed files with 235 additions and 239 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

268
API/Common_detail_api.md
View File

@ -1,7 +1,14 @@
#通用 API 说明 # 通用 API 说明
- [停止与恢复推送服务](#停止与恢复推送服务)
- [获取 RegistrationID](#获取-registrationid)
- [别名与标签 API](#别名与标签-api)
- [获取点击通知内容](#获取点击通知内容)
- [获取通知内容](#获取通知内容)
- [获取自定义消息推送内容](#获取自定义消息推送内容)
## 停止与恢复推送服务 API ## 停止与恢复推送服务
### API - init ### API - init
调用此 API,用来开启 调用此 API,用来开启
@ -9,87 +16,80 @@ JPush SDK 提供的推送服务。
开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
```
本功能是一个完全本地的状态操作。也就是说：停止推送服务的状态不会保存到服务器上。 本功能是一个完全本地的状态操作。也就是说：停止推送服务的状态不会保存到服务器上。
如果停止推送服务后，开发者 App 被重新安装，或者被清除数据， 如果停止推送服务后，开发者 App 被重新安装，或者被清除数据，
JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。 JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。
本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息，
本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息，
恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。 恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。
```
#### 接口定义 #### 接口定义
window.plugins.jPushPlugin.init() window.plugins.jPushPlugin.init()
### API - stopPush ### API - stopPush
+ 在 Android 平台 + Android 平台:
+ 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务，当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。 + 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务，当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
+ 调用了本 API 后，JPush 推送服务完全被停止，具体表现为：
+ 调用了本 API 后，JPush 推送服务完全被停止。具体表现为： + JPush Service 不在后台运行。
+ 收不到推送消息。
+ 不能通过 JPushInterface.init 恢复，需要调用 resumePush 恢复。
+ 极光推送所有的其他 API 调用都无效。
+ JPush Service 不在后台运行 + iOS 平台:
+ 收不到推送消息
+ 不能通过 JPushInterface.init 恢复，需要调用 resumePush 恢复
+ 极光推送所有的其他 API 调用都无效
+ iOS 平台 + 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化。
+ 推荐：设置一个 UI 界面， 提醒用户在 设置－通知 中关闭推送服务。
+ 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化 #### 接口定义
+ 推荐：设置一个 UI 界面， 提醒用户在 设置－通知 中关闭推送服务
### 接口定义
window.plugins.jPushPlugin.stopPush() window.plugins.jPushPlugin.stopPush()
#### API - resumePush ### API - resumePush
恢复推送服务。调用了此 API 后:
恢复推送服务。调用了此 API 后 + Android 平台:
+ 在 Android 平台 + 极光推送完全恢复正常工作。
+ 极光推送完全恢复正常工作， + iOS 平台:
+ iOS平台 + 重新去APNS注册。
+ 重新去APNS注册 #### 接口定义
##### 接口定义
window.plugins.jPushPlugin.resumePush() window.plugins.jPushPlugin.resumePush()
#### API - isPushStopped ### API - isPushStopped
+ 在 Android 平台 + Android 平台:
+ 用来检查 Push Service 是否已经被停止 + 用来检查 Push Service 是否已经被停止。
+ iOS平台 + iOS 平台:
+ 平台检查推送服务是否注册 + 平台检查推送服务是否注册。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.isPushStopped(callback) window.plugins.jPushPlugin.isPushStopped(callback)
#### 参数说明
##### 参数说明 + callback: 回调函数，用来通知 JPush 的推送服务是否开启。
+ callback 回调函数，用来通知 JPush 的推送服务是否开启 #### 代码示例
####代码示例
window.plugins.jPushPlugin.resumePush(callback) window.plugins.jPushPlugin.resumePush(callback)
var onCallback = function(data) { var onCallback = function(data) {
if(data > 0){ if(data > 0) {
// 开启 // 开启
} else { } else {
// 关闭 // 关闭
@ -97,11 +97,11 @@ JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数
} }
##获取 RegistrationID API ## 获取 RegistrationID
### API - getRegistrationID ### API - getRegistrationID
RegistrationID 定义 RegistrationID 定义:
集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时，JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。 集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时，JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。
JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
@ -110,26 +110,24 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
#### 接口定义 #### 接口定义
JPushPlugin.prototype.getRegistrationID = function(callback) JPushPlugin.prototype.getRegistrationID(callback)
##### 参数说明
无
#### 返回值 #### 返回值
调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。 调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。
#### 调用示例 #### 代码示例
window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID); window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID);
var onGetRegistradionID = function(data) { var onGetRegistradionID = function(data) {
try { try {
console.log("JPushPlugin:registrationID is " + data) console.log("JPushPlugin:registrationID is " + data);
} catch(exception) { } catch(exception) {
console.log(exception); console.log(exception);
} }
} }
##别名与标签 API ## 别名与标签 API
### API - setTagsWithAlias, setTags, setAlias ### API - setTagsWithAlias, setTags, setAlias
@ -137,7 +135,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
这几个 API 可以在 App 里任何地方调用。 这几个 API 可以在 App 里任何地方调用。
**别名 Alias** **别名 Alias**:
为安装了应用程序的用户，取个别名来标识。以后给该用户 Push 消息时，就可以用此别名来指定。 为安装了应用程序的用户，取个别名来标识。以后给该用户 Push 消息时，就可以用此别名来指定。
@ -149,7 +147,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
举例：在一个用户要登录的游戏中，可能设置别名为 userid。游戏运营时，发现该用户 3 天没有玩游戏了，则根据 userid 调用服务器端 API 发通知到客户端提醒用户。 举例：在一个用户要登录的游戏中，可能设置别名为 userid。游戏运营时，发现该用户 3 天没有玩游戏了，则根据 userid 调用服务器端 API 发通知到客户端提醒用户。
**标签 Tag** **标签 Tag**:
为安装了应用程序的用户，打上标签。其目的主要是方便开发者根据标签，来批量下发 Push 消息。 为安装了应用程序的用户，打上标签。其目的主要是方便开发者根据标签，来批量下发 Push 消息。
@ -157,122 +155,123 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
不同应用程序、不同的用户，可以打同样的标签。 不同应用程序、不同的用户，可以打同样的标签。
举例： game, old_page, women 举例： game, old_page, women。
#### 接口定义 #### 接口定义
JPushPlugin.prototype.setTagsWithAlias = function(tags, alias) JPushPlugin.prototype.setTagsWithAlias(tags, alias)
JPushPlugin.prototype.setTags = function(tags) JPushPlugin.prototype.setTags(tags)
JPushPlugin.prototype.setAlias = function(alias) JPushPlugin.prototype.setAlias(alias)
#### 参数说明 #### 参数说明
* tags * tags:
* 参数类型为数组 * 参数类型为数组。
* nil 此次调用不设置此值 * nil 此次调用不设置此值。
* 空集合表示取消之前的设置 * 空集合表示取消之前的设置。
* 每次调用至少设置一个 tag，覆盖之前的设置，不是新增 * 每次调用至少设置一个 tag，覆盖之前的设置，不是新增。
* 有效的标签组成：字母（区分大小写）、数字、下划线、汉字 * 有效的标签组成：字母（区分大小写）、数字、下划线、汉字。
* 限制：每个 tag 命名长度限制为 40 字节，最多支持设置 100 个 tag，但总长度不得超过1K字节。（判断长度需采用UTF-8编码） * 限制：每个 tag 命名长度限制为 40 字节，最多支持设置 100 个 tag，但总长度不得超过1K字节（判断长度需采用 UTF-8 编码）。
* 单个设备最多支持设置 100 个 tag，App 全局 tag 数量无限制。 * 单个设备最多支持设置 100 个 tag，App 全局 tag 数量无限制。
* alias * alias:
* 参数类型为字符串 * 参数类型为字符串。
* nil 此次调用不设置此值 * nil 此次调用不设置此值。
* 空字符串 （""）表示取消之前的设置 * 空字符串 （""）表示取消之前的设置。
* 有效的别名组成：字母（区分大小写）、数字、下划线、汉字。 * 有效的别名组成：字母（区分大小写）、数字、下划线、汉字。
* 限制：alias 命名长度限制为 40 字节。（判断长度需采用 UTF-8 编码） * 限制：alias 命名长度限制为 40 字节（判断长度需采用 UTF-8 编码）。
#### 返回值说明 #### 返回值说明
函数本身无返回值，但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果 函数本身无返回值，但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果:
document.addEventListener("jpush.setTagsWithAlias", onTagsWithAlias, false); document.addEventListener("jpush.setTagsWithAlias", onTagsWithAlias, false);
var onTagsWithAlias = function(event) { var onTagsWithAlias = function(event) {
try { try {
console.log("onTagsWithAlias"); console.log("onTagsWithAlias");
var result = "result code:"+event.resultCode + " "; var result = "result code:" + event.resultCode + " ";
result += "tags:" + event.tags + " "; result += "tags:" + event.tags + " ";
result += "alias:" + event.alias + " "; result += "alias:" + event.alias + " ";
$("#tagAliasResult").html(result); $("#tagAliasResult").html(result);
} catch(exception) { } catch(exception) {
console.log(exception) console.log(exception);
} }
} }
####错误码定义 #### 错误码定义
|Code|描述 |详细解释 | |Code|描述 |详细解释 |
|----|:----------------------------------------|:--------| |----|:----------------------------------------|:--------|
|6001|无效的设置，tag/alias 不应参数都为 null | | |6001|无效的设置，tag / alias 不应参数都为 null。 | |
|6002|设置超时 |建议重试| |6002|设置超时。 |建议重试。|
|6003|alias 字符串不合法 |有效的别名、标签组成：字母（区分大小写）、数字、下划线、汉字。| |6003|alias 字符串不合法。 |有效的别名、标签组成：字母（区分大小写）、数字、下划线、汉字。|
|6004|alias超长。 |最多 40个字节 中文 UTF-8 是 3 个字节| |6004|alias超长。 |最多 40个字节，中文 UTF-8 是 3 个字节。|
|6005|某一个 tag 字符串不合法 |有效的别名、标签组成：字母（区分大小写）、数字、下划线、汉字。| |6005|某一个 tag 字符串不合法。 |有效的别名、标签组成：字母（区分大小写）、数字、下划线、汉字。|
|6006|某一个 tag 超长 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节| |6006|某一个 tag 超长。 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节。|
|6007|tags 数量超出限制。最多 100个 |这是一台设备的限制。一个应用全局的标签数量无限制。| |6007|tags 数量超出限制，最多 100 个。 |这是一台设备的限制。一个应用全局的标签数量无限制。|
|6008|tag/alias 超出总长度限制 |总长度最多 1K 字节| |6008|tag / alias 超出总长度限制。 |总长度最多 1K 字节。|
|6011|10s内设置tag或alias大于3次 |短时间内操作过于频繁| |6011|10s内设置 tag 或 alias 大于 3 次。 |短时间内操作过于频繁。|
### 获取点击通知内容 ## 获取点击通知内容
#### event - jpush.openNotification ### event - jpush.openNotification
点击通知进入应用程序时会出发改事件 点击通知进入应用程序时会出发改事件。
#####代码示例 #### 代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
document.addEventListener("jpush.openNotification", onOpenNotification, false); document.addEventListener("jpush.openNotification", onOpenNotification, false);
- onOpenNotification需要这样写： - onOpenNotification 需要这样写：
var alertContent; var alertContent;
if(device.platform == "Android"){ if(device.platform == "Android") {
alertContent = window.plugins.jPushPlugin.openNotification.alert; alertContent = window.plugins.jPushPlugin.openNotification.alert;
}else{ } else {
alertContent = event.aps.alert; alertContent = event.aps.alert;
} }
alert("open Notificaiton:" + alertContent); alert("open Notificaiton:" + alertContent);
ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.openNotification，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意 ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.openNotification，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
+ Android + Android:
{"alert":"ding", {
"title": "title",
"alert":"ding",
"extras":{ "extras":{
"cn.jpush.android.MSG_ID":"1691785879", "yourKey": "yourValue",
"app":"com.thi.pushtest", "cn.jpush.android.MSG_ID": "1691785879",
"cn.jpush.android.ALERT":"ding", "app": "com.thi.pushtest",
"cn.jpush.android.EXTRA":{}, "cn.jpush.android.ALERT": "ding",
"cn.jpush.android.PUSH_ID":"1691785879", "cn.jpush.android.EXTRA": {},
"cn.jpush.android.NOTIFICATION_ID":1691785879, "cn.jpush.android.PUSH_ID": "1691785879",
"cn.jpush.android.NOTIFICATION_TYPE":"0"}} "cn.jpush.android.NOTIFICATION_ID": 1691785879,
"cn.jpush.android.NOTIFICATION_TYPE": "0"
}
}
+ iOS + iOS:
{ {
"aps":{ "aps":{
"badge":1, "badge": 1,
"sound":"default", "sound": "default",
"alert":"今天去哪儿" "alert": "今天去哪儿"
}, },
"key1":"value1", "key1": "value1",
"key2":"value2", "key2": "value2",
"_j_msgid":154604475 "_j_msgid": 154604475
} }
### 获取通知内容 ## 获取通知内容
#### event - jpush.receiveNotification ### event - jpush.receiveNotification
点击通知进入应用程序时会触发该事件 点击通知进入应用程序时会触发该事件。
#####代码示例 #### 代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
@ -280,30 +279,34 @@ ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.o
- onReceiveNotification 需要这样写： - onReceiveNotification 需要这样写：
var alertContent; var alertContent;
if(device.platform == "Android"){ if(device.platform == "Android") {
alertContent = window.plugins.jPushPlugin.receiveNotification.alert; alertContent = window.plugins.jPushPlugin.receiveNotification.alert;
}else{ } else {
alertContent = event.aps.alert; alertContent = event.aps.alert;
} }
alert("open Notificaiton:" + alertContent); alert("open Notificaiton:" + alertContent);
ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意 ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
+ Android + Android:
{"alert":"ding", {
"title": "title",
"alert":"ding",
"extras":{ "extras":{
"yourKey": "yourValue",
"cn.jpush.android.MSG_ID":"1691785879", "cn.jpush.android.MSG_ID":"1691785879",
"app":"com.thi.pushtest", "app":"com.thi.pushtest",
"cn.jpush.android.ALERT":"ding", "cn.jpush.android.ALERT":"ding",
"cn.jpush.android.EXTRA":{}, "cn.jpush.android.EXTRA":{},
"cn.jpush.android.PUSH_ID":"1691785879", "cn.jpush.android.PUSH_ID":"1691785879",
"cn.jpush.android.NOTIFICATION_ID":1691785879, "cn.jpush.android.NOTIFICATION_ID":1691785879,
"cn.jpush.android.NOTIFICATION_TYPE":"0"}} "cn.jpush.android.NOTIFICATION_TYPE":"0"
}
}
+ iOS + iOS:
{ {
"aps":{ "aps":{
@ -317,17 +320,13 @@ ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r
} }
### 获取自定义消息推送内容 ## 获取自定义消息推送内容
### event - jpush.receiveMessage
####event - jpush.receiveMessage 收到应用内消息时触发这个事件，推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码。
收到应用内消息时触发这个事件 #### 代码示例
`推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码`
#####代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
@ -335,7 +334,6 @@ ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r
- onReceiveMessage 需要这样写： - onReceiveMessage 需要这样写：
var onReceiveMessage = function(event) { var onReceiveMessage = function(event) {
try{ try{
var message var message
@ -346,29 +344,29 @@ ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r
} }
$("#messageResult").html(message); $("#messageResult").html(message);
} } catch(exception) {
catch(exception) {
console.log("JPushPlugin:onReceiveMessage-->" + exception); console.log("JPushPlugin:onReceiveMessage-->" + exception);
} }
} }
ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveMessage，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意 ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveMessage，
直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
+ Android + Android:
{"message":"今天去哪儿", {
"message":"今天去哪儿",
"extras"{ "extras"{
"yourKey": "yourValue",
"cn.jpush.android.MSG_ID":"154378013", "cn.jpush.android.MSG_ID":"154378013",
"cn.jpush.android.CONTENT_TYPE":"", "cn.jpush.android.CONTENT_TYPE":"",
"cn.jpush.android.EXTRA":{"key":"不添没有"} "cn.jpush.android.EXTRA":{"key":"不添没有"}
} }
} }
+ iOS
+ iOS：
{ {
"content":"今天去哪儿", "content":"今天去哪儿",
"extras": "extras":{"key":"不填写没有"}
{
"key":"不填写没有"
}
} }

92
README.md
View File

@ -1,4 +1,4 @@
## JPush PhoneGap/Cordova Plugin ## # JPush PhoneGap / Cordova Plugin
[![Build Status](https://travis-ci.org/jpush/jpush-phonegap-plugin.svg?branch=master)](https://travis-ci.org/jpush/jpush-phonegap-plugin) [![Build Status](https://travis-ci.org/jpush/jpush-phonegap-plugin.svg?branch=master)](https://travis-ci.org/jpush/jpush-phonegap-plugin)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jpush/jpush-phonegap-plugin) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jpush/jpush-phonegap-plugin)
@ -6,12 +6,9 @@
[![platforms](https://img.shields.io/badge/platforms-iOS%7CAndroid-lightgrey.svg)](https://github.com/jpush/jpush-phonegap-plugin-plugin) [![platforms](https://img.shields.io/badge/platforms-iOS%7CAndroid-lightgrey.svg)](https://github.com/jpush/jpush-phonegap-plugin-plugin)
[![weibo](https://img.shields.io/badge/weibo-JPush-blue.svg)](http://weibo.com/jpush?refer_flag=1001030101_&is_all=1) [![weibo](https://img.shields.io/badge/weibo-JPush-blue.svg)](http://weibo.com/jpush?refer_flag=1001030101_&is_all=1)
JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。 支持 iOS, Android 的 Cordova 推送插件。
**功能特性：** ## 功能特性
支持 iOS, Android 的极光推送插件。
### 功能特性
+ 发送推送通知。 + 发送推送通知。
+ 发送推送自定义消息。 + 发送推送自定义消息。
+ 设置推送标签和别名。 + 设置推送标签和别名。
@ -26,74 +23,69 @@ JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。
cordova create Myproj com.myproj.jpush MyTestProj cordova create Myproj com.myproj.jpush MyTestProj
2. 添加平台 2. 添加平台:
cd Myproj cd Myproj
cordova platform add android cordova platform add android
cordova platform add ios cordova platform add ios
ps:这里请注意iOS平台，必须先执行 `cordova platform add ios`, ps: 这里请注意iOS平台，必须先执行 cordova platform add ios,
然后再执行 `cordova plugin add xxxxx` 命令，不然有一些必须要的链接库需要手动添加 然后再执行 cordova plugin add xxxxx 命令，不然有一些必须要的链接库需要手动添加。
### Cordova CLI / PhoneGap 安装 Android & iOS ### 安装插件(Android & iOS)
1). 安装 JPush PhoneGap Plugin, 有两种方法： #### 1.安装 JPush PhoneGap Plugin
安装 JPush PhoneGap Plugin 有两种方法：
方法一：在线安装 方法一：在线安装
通过 cordova plugins 安装，要求 phonegap/cordova CLI 5.0+ 通过 cordova plugins 安装，要求 phonegap/cordova CLI 5.0+:
cordova plugin add jpush-phonegap-plugin --variable API_KEY=your_jpush_appkey cordova plugin add jpush-phonegap-plugin --variable API_KEY=your_jpush_appkey
直接通过 url 安装 直接通过 url 安装:
cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable API_KEY=your_jpush_appkey cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable API_KEY=your_jpush_appkey
方法二：下载到本地再安装 方法二：下载到本地再安装
使用 git 命令将 JPush PhoneGap 插件下载的本地,将这个目录标记为 `$JPUSH_PLUGIN_DIR` 使用 git 命令将 JPush PhoneGap 插件下载的本地，目录标记为 $JPUSH_PLUGIN_DIR。
git clone https://github.com/jpush/jpush-phonegap-plugin.git git clone https://github.com/jpush/jpush-phonegap-plugin.git
cordova plugin add $JPUSH_PLUGIN_DIR --variable API_KEY=your_jpush_appkey cordova plugin add $JPUSH_PLUGIN_DIR --variable API_KEY=your_jpush_appkey
[Android 手动安装文档地址](API/Android_handle_install.md)
2). 安装 org.apache.cordova.device [IOS 手动安装文档地址](API/iOS_install.md)
#### 2.安装 org.apache.cordova.device 插件
cordova plugin add org.apache.cordova.device cordova plugin add org.apache.cordova.device
3). 在 js 中调用函数,初始化 JPush SDK #### 3.在 js 中调用函数，初始化 JPush
//由于 PhoneGap 插件采用了 Lazy load 的特性，所以建议在 js 文件能执行的最开始就添加 //由于 PhoneGap 插件采用了 Lazy load 的特性，所以建议在 js 文件能执行的最开始就添加
window.plugins.jPushPlugin.init(); window.plugins.jPushPlugin.init();
### Android 手动安装
[Android 手动安装文档地址](API/Android_handle_install.md) ## Demo
插件中包含示例 Demo。若想参考，可以在 $JPUSH_PLUGIN_DIR/example 文件夹内找到并拷贝以下文件:
src/example/index.html -> www/index.html
src/example/css/* -> www/css
src/example/js/* -> www/js
### iOS 手动安装 ## 关于 PhoneGap build 云服务
[IOS 手动安装文档地址](API/iOS_install.md) 该项目基于 cordova 实现，目前无法使用 PhoneGap build 云服务进行打包，建议使用本地环境进行打包。
### 示例
"$JPUSH_PLUGIN_DIR/example"文件夹内找到并拷贝以下文件
src/example/index.html to www/index.html
src/example/css/* to www/css
src/example/js/* to www/js
### 关于'PhoneGap build'云服务
该项目基于 cordova 实现，目前无法使用 'PhoneGap build' 云服务进行打包，建议使用本地环境进行打包
## API 说明 ## API 说明
插件的 API 集中在 JPushPlugin.js 文件中,该文件的具体位置如下： 插件的 API 集中在 JPushPlugin.js 文件中，该文件的具体位置如下：
Android: Android:
@ -112,29 +104,35 @@ iOS:
- [Android API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/Android_detail_api.md) - [Android API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/Android_detail_api.md)
### 常见问题 ## 常见问题
若要使用 CLI 来编译项目，注意使用 cordova compile 而不是 cordova build，因为 cordova build 会覆盖掉对插件的修改。 若要使用 CLI 来编译项目，注意使用 cordova compile 而不是 cordova build，因为 cordova build 会清除对插件文件的修改。
具体 cordova CLI 用法可参考[cordova CLI 官方文档](https://cordova.apache.org/docs/en/latest/reference/cordova-cli/index.html)。
#### 1. Android ### 1. Android
eclipse 中 PhoneGap 工程 import 之后出现：`Type CallbackContext cannot be resolved to a type` eclipse 中 import PhoneGap 工程之后出现：`Type CallbackContext cannot be resolved to a type`。
解决方案：eclipse 中右键单击工程名，Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add
#### 2. iOS 解决方案：eclipse 中右键单击工程名，Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add。
- 设置 / 修改 APP_KEY ### 2. iOS
- 设置 / 修改 APP_KEY:
在 PushConfig.plist 中修改。 在 PushConfig.plist 中修改。
PushConfig.plist 其他值说明： PushConfig.plist 中其他值说明：
CHANNEL: 渠道标识
IsProduction: 是否生产环境（暂未启用）
- 收不到推送 - CHANNEL: 渠道标识。
- IsProduction: 是否生产环境（暂未启用）。
- 收不到推送:
请首先按照正确方式再次配置证书、描述文件 请首先按照正确方式再次配置证书、描述文件
[iOS 证书 设置指南](http://docs.jpush.io/client/ios_tutorials/#ios_1) [iOS 证书设置指南](http://docs.jpush.io/client/ios_tutorials/#ios_1)。
### 更多 ## 更多
[JPush 官网文档](http://docs.jpush.io/) [JPush 官网文档](http://docs.jpush.io/)
如有问题可访问[极光社区](http://community.jpush.cn/)