diff --git a/README.md b/README.md
index 5a65a37..eff1786 100644
--- a/README.md
+++ b/README.md
@@ -63,14 +63,14 @@ JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。
window.plugins.jPushPlugin.init();
-### Android 手工安装
+### Android 手动安装
-[Android 手工安装文档地址](document/Android_handle_install.md)
+[Android 手动安装文档地址](document/Android_handle_install.md)
-### iOS 手工安装
+### iOS 手动安装
-[IOS手工安装文档地址](document/iOS_handle_install.md)
+[IOS手动安装文档地址](document/iOS_handle_install.md)
###示例
@@ -118,6 +118,8 @@ iOS:
window.plugins.jPushPlugin.setTags(tags)
window.plugins.jPushPlugin.setAlias(alias)
+ event - jpush.setTagsWithAlias //三个方法都是触发该回调事件
+
+ 获取点击通知内容
event - jpush.openNotification
@@ -137,10 +139,11 @@ iOS:
+ 获取自定义消息推送内容
- event - jpush.receiveMessage
//推荐使用事件的方式传递,但同时保留了 receiveMessageIniOSCallback 的回调函数,兼容以前的代码
window.plugins.jPushPlugin.receiveMessageIniOSCallback(data)
+ event - jpush.receiveMessage
+
+ 页面的统计
window.plugins.jPushPlugin.startLogPageView(pageName)
@@ -156,7 +159,8 @@ iOS:
+ 本地通知
- window.plugins.JPushPlugin.addLocalNotificationForIOS(delayTime, content, badge, notificationID, extras)
+ window.plugins.JPushPlugin.addLocalNotificationForIOS(delayTime, content,
+ badge, notificationID, extras)
window.plugins.JPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS()
window.plugins.JPushPlugin.clearAllLocalNotifications()
@@ -231,6 +235,5 @@ iOS:
IsProduction: 是否生产环境(暂未启用)
-
###更多
- [ JPush 官网文档](http://docs.jpush.io/)
+ [JPush 官网文档](http://docs.jpush.io/)
diff --git a/document/Android_detail_api.md b/document/Android_detail_api.md
index cb9af83..8956404 100644
--- a/document/Android_detail_api.md
+++ b/document/Android_detail_api.md
@@ -1,12 +1,36 @@
## Android API简介
+### 接收通知时获得通知的信息
+
+- 内容
+ window.plugins.jPushPlugin.receiveNotification.alert;
+- 标题
+ window.plugins.jPushPlugin.receiveNotification.title;
+- 附加字段
+ window.plugins.jPushPlugin.receiveNotification.extras.yourKey;
+
+### 打开通知时获得通知的信息
+
+- 内容
+ window.plugins.jPushPlugin.openNotification.alert;
+- 标题
+ window.plugins.jPushPlugin.openNotification.title;
+- 附加字段
+ window.plugins.jPushPlugin.openNotification.extras.yourKey;
+
+### 收到自定义消息时获得通知的信息
+
+- 内容
+ window.plugins.jPushPlugin.openNotification.message;
+- 附加字段
+ window.plugins.jPushPlugin.openNotification.extras.yourKey;
### 获取集成日志
#### API - setDebugMode
-用于开启调试模式,可以查看集成 JPush 过程中的 Log,如果集成失败,可方便定位问题所在
+用于开启调试模式,可以查看集成 JPush 过程中的 Log,如果集成失败,可方便定位问题所在。
##### 接口定义
@@ -23,27 +47,28 @@
### 接收消息和点击通知事件
#### API - receiveMessageInAndroidCallback
-用于 Android 收到应用内消息的回调函数(请注意和通知的区别),该函数不需要主动调用
+用于 Android 收到应用内消息的回调函数(请注意和通知的区别),该函数不需要主动调用。
##### 接口定义
window.plugins.jPushPlugin.receiveMessageInAndroidCallback = function(data)
##### 参数说明
-- data 接收到的 js 字符串,包含的 key:value 请进入该函数体查看
+
+- data 接收到的 js 字符串,包含的 key:value 请进入该函数体查看。
##### 代码示例
#### API - openNotificationInAndroidCallback
-当点击 Android 手机的通知栏进入应用程序时,会调用这个函数,这个函数不需要主动调用,是作为回调函数来用的
-
+当点击 Android 手机的通知栏进入应用程序时,会调用这个函数,这个函数不需要主动调用,是作为回调函数来用的。
##### 接口定义
window.plugins.jPushPlugin.openNotificationInAndroidCallback = function(data)
##### 参数说明
+
- data js字符串
##### 代码示例
@@ -51,18 +76,20 @@
### 统计分析 API
#### API - onResume / onPause
-这是一个 android local api,不是 js 的 API,请注意
-本 API 用于“用户使用时长”,“活跃用户”,“用户打开次数”的统计,并上报到服务器,在 Portal 上展示给开发者。
+这是一个 Android Local API,不是 js 的 API,请注意
+本 API 用于“用户使用时长”,“活跃用户”,“用户打开次数”的统计,并上报到服务器,在 Portal 上展示给开发者。
####接口定义
public static void onResume(final Activity activity)
public static void onPause(final Activity activity)
+
####参数说明
- + Activity activity 当前所在的 Activity。
+ + Activity 当前所在的 Activity。
+
####调用说明
应在所有的 Activity 的 onResume / onPause 方法里调用。
@@ -74,6 +101,7 @@
super.onResume();
JPushInterface.onResume(this);
}
+
@Override
protected void onPause() {
super.onPause();
@@ -90,22 +118,22 @@
window.plugins.jPushPlugin.setStatisticsOpen(boolean)
#### 参数说明
+
- boolean
- -true : 打开统计分析功能
- -false: 关闭统计分析功能
+ - true : 打开统计分析功能
+ - false: 关闭统计分析功能
#### API - reportNotificationOpened
用于上报用户的通知栏被打开,或者用于上报用户自定义消息被展示等客户端需要统计的事件。
-
##### 接口定义
window.plugins.jPushPlugin.reportNotificationOpened(msgID)
##### 参数说明
- msgID
- -收到的通知或者自定义消息的 id
+ - 收到的通知或者自定义消息的 id
### 清除通知 API
@@ -114,7 +142,7 @@
推送通知到客户端时,由 JPush SDK 展现通知到通知栏上。
-此 API 提供清除通知的功能,包括:清除所有 JPush 展现的通知(不包括非 JPush SDK 展现的)
+此 API 提供清除通知的功能,包括:清除所有 JPush 展现的通知(不包括非 JPush SDK 展现的)。
##### 接口定义
@@ -131,9 +159,9 @@
极光 Push SDK 提供了 2 个用于定制通知栏样式的构建类:
- setBasicPushNotificationBuilder
- - Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)
+ - Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)。
- setCustomPushNotificationBuilder
- - 继承 Basic 进一步让开发者定制 Notification Layout
+ - 继承 Basic 进一步让开发者定制 Notification Layout。
如果不调用此方法定制,则极光 Push SDK 默认的通知栏样式是:Android 标准的通知栏提示。
@@ -166,14 +194,14 @@
#### API - addLocalNotification,removeLocalNotification,clearLocalNotifications
-本地通知 API 不依赖于网络,无网条件下依旧可以触发
+本地通知 API 不依赖于网络,无网条件下依旧可以触发。
-本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制
+本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制。
-本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响
+本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响。
-三个接口的功能分别为:添加一个本地通知,删除一个本地通知,删除所有的本地通知
+三个接口的功能分别为:添加一个本地通知,删除一个本地通知,删除所有的本地通知。
#####接口定义
@@ -184,9 +212,9 @@
##### 参数说明
-- builderId 设置本地通知样式
-- content 设置本地通知的 content
-- title 设置本地通知的 title
-- notificaitonID 设置本地通知的 ID
-- broadcastTime 设置本地通知触发时间,为距离当前时间的数值,单位是毫秒
-- extras 设置额外的数据信息 extras 为 json 字符串
+- builderId 设置本地通知样式。
+- content 设置本地通知的 content。
+- title 设置本地通知的 title。
+- notificaitonID 设置本地通知的 ID。
+- broadcastTime 设置本地通知触发时间,为距离当前时间的数值,单位是毫秒。
+- extras 设置额外的数据信息 extras 为 json 字符串。
diff --git a/document/Android_handle_install.md b/document/Android_handle_install.md
index cf5a9cf..31d15c4 100644
--- a/document/Android_handle_install.md
+++ b/document/Android_handle_install.md
@@ -1,13 +1,21 @@
-#Android 手工安装
+#Android 手动安装
下载 JPush PhoneGap 插件,并解压缩,标记插件目录为:`$JPUSH_PLUGIN_DIR`
-1. 复制:`$JPUSH_PLUGIN_DIR`/src/android/*.java 到 cn/jpush/phonega/ 目录下(即:cn.jpush.phonegap 的包下)
-2. 复制:`$JPUSH_PLUGIN_DIR`/src/android/armeabi/libjpush.so 到 lib/armeabi/
-3. 复制:`$JPUSH_PLUGIN_DIR`/src/android/jpush-sdk-release2.0.6.jar 到 lib/
-4. 复制:`$JPUSH_PLUGIN_DIR`/src/android/test_notification_layout.xml 到 res/layout/
-5. 复制:`$JPUSH_PLUGIN_DIR`/src/android/jpush_notification_icon.png 到 res/drawable/
-6. 修改 AndroidManifest.xml 在 manifest 节点下添加以下权限
+1. 复制:$JPUSH_PLUGIN_DIR/src/android/*.java 到 cn/jpush/phonega/ 目录下(即:cn.jpush.phonegap 的包下)
+2. 复制:$JPUSH_PLUGIN_DIR/src/android/armeabi/libjpush.so 到 lib/armeabi/
+3. 复制:$JPUSH_PLUGIN_DIR/src/android/jpush-sdk-release2.0.6.jar 到 lib/
+4. 复制:$JPUSH_PLUGIN_DIR/src/android/test_notification_layout.xml 到 res/layout/
+5. 复制:$JPUSH_PLUGIN_DIR/src/android/jpush_notification_icon.png 到 res/drawable/
+6. 复制:$JPUSH_PLUGIN_DIR/www/JPushPlugin.js 到 assets/www/plugins/cn.jpush.phonegap.JPushPlugin.www/
+ 和 platform_www/plugins/cn.jpush.phonegap.JPushPlugin/www/
+ 并在 JPushPlugin.js 文件的代码外添加:
+
+ cordova.define("cn.jpush.phonegap.JPushPlugin.JPushPlugin", function(require, exports, module) {
+ // 代码
+ });
+
+7. 修改 AndroidManifest.xml 在 manifest 节点下添加以下权限