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

update doc

Browse Source
This commit is contained in:
Hevin
2016-04-21 20:32:28 +08:00
parent c9cb88b9ef
commit 706f32a972
3 changed files with 329 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API/Android_detail_api.md
+113 -107
View File
@@ -1,86 +1,95 @@
## Android API简介 # Android API简介
- [接收通知时获得通知的内容](#接收通知时获得通知的内容)
- [打开通知时获得通知的内容](#打开通知时获得通知的内容)
- [收到自定义消息时获取消息的内容](#收到自定义消息时获取消息的内容)
- [获取集成日志](#获取集成日志)
- [接收消息和点击通知事件](#接收消息和点击通知事件)
- [统计分析](#统计分析)
- [清除通知](#清除通知)
- [设置允许推送时间](#设置允许推送时间)
- [设置通知静默时间](#设置通知静默时间)
- [通知栏样式定制](#通知栏样式定制)
- [设置保留最近通知条数](#设置保留最近通知条数)
- [本地通知](#本地通知)
### 接收通知时获得通知的信息 ## 接收通知时获得通知的内容
- 内容 - 内容:
window.plugins.jPushPlugin.receiveNotification.alert; window.plugins.jPushPlugin.receiveNotification.alert
- 标题 - 标题:
window.plugins.jPushPlugin.receiveNotification.title; window.plugins.jPushPlugin.receiveNotification.title
- 附加字段:
window.plugins.jPushPlugin.receiveNotification.extras.yourKey
## 打开通知时获得通知的内容
- 内容:
window.plugins.jPushPlugin.openNotification.alert
- 标题:
window.plugins.jPushPlugin.openNotification.title
- 附加字段 - 附加字段
window.plugins.jPushPlugin.receiveNotification.extras.yourKey; window.plugins.jPushPlugin.openNotification.extras.yourKey
### 打开通知时获得通知的信息 ## 收到自定义消息时获取消息的内容
- 内容 - 内容:
window.plugins.jPushPlugin.openNotification.alert; window.plugins.jPushPlugin.receiveMessage.message
- 标题 - 附加字段:
window.plugins.jPushPlugin.openNotification.title; window.plugins.jPushPlugin.receiveMessage.extras.yourKey
- 附加字段
window.plugins.jPushPlugin.openNotification.extras.yourKey;
### 收到自定义消息时获得通知的信息 ## 获取集成日志
- 内容 ### API - setDebugMode
window.plugins.jPushPlugin.receiveMessage.message;
- 附加字段
window.plugins.jPushPlugin.receiveMessage.extras.yourKey;
### 获取集成日志
#### API - setDebugMode
用于开启调试模式，可以查看集成 JPush 过程中的 Log，如果集成失败，可方便定位问题所在。 用于开启调试模式，可以查看集成 JPush 过程中的 Log，如果集成失败，可方便定位问题所在。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.setDebugMode(mode) window.plugins.jPushPlugin.setDebugMode(mode)
##### 参数说明 #### 参数说明
- mode的值 - mode:
- true 显示集成日志。
- true 显示集成日志 - false 不显示集成日志。
- false 不显示集成日志
### 接收消息和点击通知事件 ## 接收消息和点击通知事件
#### API - receiveMessageInAndroidCallback ### API - receiveMessageInAndroidCallback
用于 Android 收到应用内消息的回调函数(请注意和通知的区别)，该函数不需要主动调用。 用于 Android 收到应用内消息的回调函数(请注意和通知的区别)，该函数不需要主动调用。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.receiveMessageInAndroidCallback = function(data) window.plugins.jPushPlugin.receiveMessageInAndroidCallback(data)
##### 参数说明 #### 参数说明
- data 接收到的 js 字符串，包含的 key:value 请进入该函数体查看。 - data: 接收到的 js 字符串，包含的 key:value 请进入该函数体查看。
##### 代码示例
#### API - openNotificationInAndroidCallback ### API - openNotificationInAndroidCallback
当点击 Android 手机的通知栏进入应用程序时,会调用这个函数，这个函数不需要主动调用，是作为回调函数来用的。 当点击 Android 手机的通知栏进入应用程序时，会调用这个函数，这个函数不需要主动调用，是作为回调函数来用的。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.openNotificationInAndroidCallback = function(data) window.plugins.jPushPlugin.openNotificationInAndroidCallback(data)
##### 参数说明 #### 参数说明
- data js字符串 - data: js 字符串。
##### 代码示例
### 统计分析 API ## 统计分析
#### API - onResume / onPause ### API - onResume / onPause
这是一个 Android Local API，不是 js 的 API，请注意 这是一个 Android Local API，不是 js 的 API，请注意。
本 API 用于“用户使用时长”，“活跃用户”，“用户打开次数”的统计，并上报到服务器，在 Portal 上展示给开发者。 本 API 用于“用户使用时长”，“活跃用户”，“用户打开次数”的统计，并上报到服务器，在 Portal 上展示给开发者。
#### 接口定义 #### 接口定义
public static void onResume(final Activity activity) public static void onResume(final Activity activity)
@@ -88,7 +97,7 @@
#### 参数说明 #### 参数说明
＋ Activity 当前所在的 Activity。 - Activity: 当前所在的 Activity。
#### 调用说明 #### 调用说明
@@ -108,7 +117,7 @@
JPushInterface.onPause(this); JPushInterface.onPause(this);
} }
#### API - setStatisticsOpen(boolean) ### API - setStatisticsOpen
用于在 js 中控制是否打开应用的统计分析功能，但如果已经添加了上面的 onResume / onPause 方法， 用于在 js 中控制是否打开应用的统计分析功能，但如果已经添加了上面的 onResume / onPause 方法，
就不能再通过这个方法来控制统计分析功能了。 就不能再通过这个方法来控制统计分析功能了。
@@ -119,77 +128,78 @@
#### 参数说明 #### 参数说明
- boolean - boolean:
- true : 打开统计分析功能 - true: 打开统计分析功能。
- false: 关闭统计分析功能 - false: 关闭统计分析功能。
#### API - reportNotificationOpened ### API - reportNotificationOpened
用于上报用户的通知栏被打开，或者用于上报用户自定义消息被展示等客户端需要统计的事件。 用于上报用户的通知栏被打开，或者用于上报用户自定义消息被展示等客户端需要统计的事件。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.reportNotificationOpened(msgID) window.plugins.jPushPlugin.reportNotificationOpened(msgID)
##### 参数说明 #### 参数说明
- msgID
- 收到的通知或者自定义消息的 id - msgID: 收到的通知或者自定义消息的 id。
### 清除通知 API ## 清除通知
#### API - clearAllNotification ### API - clearAllNotification
推送通知到客户端时，由 JPush SDK 展现通知到通知栏上。 推送通知到客户端时，由 JPush SDK 展现通知到通知栏上。
此 API 提供清除通知的功能，包括：清除所有 JPush 展现的通知（不包括非 JPush SDK 展现的）。 此 API 提供清除通知的功能，包括：清除所有 JPush 展现的通知（不包括非 JPush SDK 展现的）。
#### 接口定义
##### 接口定义
window.plugins.jPushPlugin.clearAllNotification() window.plugins.jPushPlugin.clearAllNotification()
### 设置允许推送时间 API
#### API - setPushTime ## 设置允许推送时间
### API - setPushTime
默认情况下用户在任何时间都允许推送。即任何时候有推送下来，客户端都会收到，并展示。 默认情况下用户在任何时间都允许推送。即任何时候有推送下来，客户端都会收到，并展示。
开发者可以调用此 API 来设置允许推送的时间。 开发者可以调用此 API 来设置允许推送的时间。
如果不在该时间段内收到消息，当前的行为是：推送到的通知会被扔掉。 如果不在该时间段内收到消息，当前的行为是：推送到的通知会被扔掉。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.setPushTime(days, startHour, endHour) window.plugins.jPushPlugin.setPushTime(days, startHour, endHour)
##### 参数说明 #### 参数说明
- days: 数组 0表示星期天，1表示星期一，以此类推。 （7天制，数组中的int范围为0到6）set的值为null, 表示任何时间都可以收到消息和通知，set的size为0，则表示任何时间都收不到消息和通知. - days: 数组，0 表示星期天，1 表示星期一，以此类推（7天制，数组中值的范围为 0 到 6 ）。
- startHour: int 允许推送的开始时间 （24小时制：startHour的范围为0到23） 数组的值为 null, 表示任何时间都可以收到消息和通知，数组的 size 为 0，则表示任何时间都收不到消息和通知。
- endHour: int 允许推送的结束时间 （24小时制：endHour的范围为0到23） - startHour: 整形，允许推送的开始时间 （24 小时制：startHour 的范围为 0 到 23）。
- endHour: 整形，允许推送的结束时间 （24 小时制：endHour 的范围为 0 到 23）。
### 设置通知静默时间 API ## 设置通知静默时间
#### API - setSilenceTime ### API - setSilenceTime
默认情况下用户在收到推送通知时，客户端可能会有震动，响铃等提示。但用户在睡觉、开会等时间点希望为 "免打扰" 模式，也是静音时段的概念。 默认情况下用户在收到推送通知时，客户端可能会有震动，响铃等提示。
但用户在睡觉、开会等时间点希望为 "免打扰" 模式，也是静音时段的概念。
开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息，则：不会有铃声和震动。 开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息，则：不会有铃声和震动。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.setSilenceTime(startHour, startMinute, endHour, endMinute) window.plugins.jPushPlugin.setSilenceTime(startHour, startMinute, endHour, endMinute)
##### 参数说明 #### 参数说明
- startHour: int 静音时段的开始时间 - 小时 （24小时制，范围：0~23 ） - startHour: 整形，静音时段的开始时间 - 小时 （24小时制，范围：0~23 ）。
- startMinute: int 静音时段的开始时间 - 分钟（范围：0~59 ） - startMinute: 整形，静音时段的开始时间 - 分钟（范围：0~59 ）。
- endHour: 静音时段的结束时间 - 小时 （24小时制，范围：0~23 ） - endHour: 整形，静音时段的结束时间 - 小时 （24小时制，范围：0~23 ）。
- endMinute: 静音时段的结束时间 - 分钟（范围：0~59 ） - endMinute: 整形，静音时段的结束时间 - 分钟（范围：0~59 ）。
### 通知栏样式定制 API ## 通知栏样式定制
### API - setBasicPushNotificationBuilder, setCustomPushNotificationBuilder
#### API - setBasicPushNotificationBuilder, setCustomPushNotificationBuilder
当用户需要定制默认的通知栏样式时，则可调用此方法。 当用户需要定制默认的通知栏样式时，则可调用此方法。
极光 Push SDK 提供了 2 个用于定制通知栏样式的构建类： JPush SDK 提供了 2 个用于定制通知栏样式的构建类：
- setBasicPushNotificationBuilder - setBasicPushNotificationBuilder
- Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式（行为）。 - Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式（行为）。
@@ -198,34 +208,31 @@
如果不调用此方法定制，则极光 Push SDK 默认的通知栏样式是：Android 标准的通知栏提示。 如果不调用此方法定制，则极光 Push SDK 默认的通知栏样式是：Android 标准的通知栏提示。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.setBasicPushNotificationBuilder = function() window.plugins.jPushPlugin.setBasicPushNotificationBuilder()
window.plugins.jPushPlugin.setCustomPushNotificationBuilder = function() window.plugins.jPushPlugin.setCustomPushNotificationBuilder()
### 设置保留最近通知条数 API ## 设置保留最近通知条数
#### API - setLatestNotificationNum ### API - setLatestNotificationNum
通过极光推送，推送了很多通知到客户端时，如果用户不去处理，就会有很多保留在那里。 通过极光推送，推送了很多通知到客户端时，如果用户不去处理，就会有很多保留在那里。
新版本 SDK (v1.3.0) 增加此功能，限制保留的通知条数。默认为保留最近 5 条通知。 默认为保留最近 5 条通知，开发者可通过调用此 API 来定义为不同的数量。
开发者可通过调用此 API 来定义为不同的数量。 #### 接口定义
##### 接口定义
window.plugins.jPushPlugin.setLatestNotificationNum(num) window.plugins.jPushPlugin.setLatestNotificationNum(num)
##### 参数说明 #### 参数说明
- num 保存的条数 - num: 保存的条数。
### 本地通知 API ## 本地通知
#### API - addLocalNotification,removeLocalNotification,clearLocalNotifications ### API - addLocalNotification, removeLocalNotification, clearLocalNotifications
本地通知 API 不依赖于网络，无网条件下依旧可以触发。 本地通知 API 不依赖于网络，无网条件下依旧可以触发。
@@ -233,21 +240,20 @@
本地通知的定时时间是自发送时算起的，不受中间关机等操作的影响。 本地通知的定时时间是自发送时算起的，不受中间关机等操作的影响。
三个接口的功能分别为：添加一个本地通知，删除一个本地通知，删除所有的本地通知。 三个接口的功能分别为：添加一个本地通知，删除一个本地通知，删除所有的本地通知。
#####接口定义 #####接口定义
window.plugins.jPushPlugin.addLocalNotification = function(builderId, window.plugins.jPushPlugin.addLocalNotification(builderId, content, title,
content, title, notificaitonID, broadcastTime, extras) notificaitonID, broadcastTime, extras)
window.plugins.jPushPlugin.removeLocalNotification = function(notificationID) window.plugins.jPushPlugin.removeLocalNotification(notificationID)
window.plugins.jPushPlugin.clearLocalNotifications = function() window.plugins.jPushPlugin.clearLocalNotifications()
##### 参数说明 #### 参数说明
- builderId 设置本地通知样式。 - builderId: 设置本地通知样式。
- content 设置本地通知的 content。 - content: 设置本地通知的 content。
- title 设置本地通知的 title。 - title: 设置本地通知的 title。
- notificaitonID 设置本地通知的 ID。 - notificaitonID: 设置本地通知的 ID。
- broadcastTime 设置本地通知触发时间，为距离当前时间的数值，单位是毫秒。 - broadcastTime: 设置本地通知触发时间，为距离当前时间的数值，单位是毫秒。
- extras 设置额外的数据信息 extras 为 json 字符串。 - extras: 设置额外的数据信息 extras 为 json 字符串。
API/iOS API.md
+173 -170
View File
@@ -1,21 +1,32 @@
## iOS API # iOS API
- [开始与停止推送服务](#开始与停止推送服务)
- [获取 RegistrationID](#获取-registrationid)
- [别名与标签](#别名与标签)
- [获取 APNS 推送内容](#获取-apns-推送内容)
- [点击推送获取](#点击推送获取)
- [前台获取](#前台获取)
- [获取自定义消息内容](#获取自定义消息内容)
- [设置Badge](#设置badge)
- [本地通知](#本地通知)
- [页面的统计](#页面的统计)
- [日志等级设置](#日志等级设置)
- [地理位置上报](#地理位置上报)
- [设备平台判断](#设备平台判断)
## 开始与停止推送服务
## 开始与停止推送服务 API
### API - init ### API - init
调用此 API,用来开启 调用此 API,用来开启 JPush SDK 提供的推送服务。
JPush SDK 提供的推送服务。
开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务，当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
``` ```
本功能是一个完全本地的状态操作。也就是说：停止推送服务的状态不会保存到服务器上。 本功能是一个完全本地的状态操作。也就是说：停止推送服务的状态不会保存到服务器上。
如果停止推送服务后，开发者 App 被重新安装，或者被清除数据， 如果停止推送服务后，开发者 App 被重新安装，或者被清除数据，
JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。 JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。
本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息， 本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息，
恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。 恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。
``` ```
@@ -23,38 +34,38 @@ JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数
window.plugins.jPushPlugin.init() window.plugins.jPushPlugin.init()
### API - stopPush ### API - stopPush
+ 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化 - 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化。
+ 推荐：设置一个 UI 界面， 提醒用户在 设置－通知 中关闭推送服务 - 推荐：设置一个 UI 界面，提醒用户在 设置－通知 中关闭推送服务。
### 接口定义 #### 接口定义
window.plugins.jPushPlugin.stopPush() window.plugins.jPushPlugin.stopPush()
#### API - resumePush ### API - resumePush
恢复推送服务。调用了此 API 后，iOS平台，重新去APNS注册。
恢复推送服务。调用了此 API 后，iOS平台，重新去APNS注册 #### 接口定义
##### 接口定义
window.plugins.jPushPlugin.resumePush() window.plugins.jPushPlugin.resumePush()
#### API - isPushStopped
iOS平台，检查推送服务是否注册 ### API - isPushStopped
##### 接口定义 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)
@@ -67,11 +78,11 @@ iOS平台，检查推送服务是否注册
} }
##获取 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 到应用程序。
@@ -80,10 +91,8 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
#### 接口定义 #### 接口定义
JPushPlugin.prototype.getRegistrationID = function(callback) JPushPlugin.prototype.getRegistrationID(callback)
##### 参数说明
无
#### 返回值 #### 返回值
调用此 API 来取得应用程序对应的 RegistrationID。只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。 调用此 API 来取得应用程序对应的 RegistrationID。只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。
@@ -93,13 +102,13 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
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 - setTagsWithAlias, setTags, setAlias ### API - setTagsWithAlias, setTags, setAlias
@@ -127,33 +136,33 @@ 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) {
@@ -170,20 +179,17 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
#### 错误码定义 #### 错误码定义
|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次 |短时间内操作过于频繁。|
## 获取 APNS 推送内容 ## 获取 APNS 推送内容
@@ -192,9 +198,9 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
#### event - jpush.openNotification #### event - jpush.openNotification
点击通知进入应用程序时会出发改事件 点击通知进入应用程序时会出发改事件。
#####代码示例 #### 代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
@@ -202,15 +208,13 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
- onOpenNotification 需要这样写： - onOpenNotification 需要这样写：
var onOpenNotification = function(event) { var onOpenNotification = function(event) {
var alertContent; var alertContent;
alertContent = event.aps.alert; alertContent = event.aps.alert;
alert("open Notificaiton:" + alertContent); alert("open Notificaiton:" + alertContent);
} }
- event 举例:
+ event 举例
{ {
"aps":{ "aps":{
@@ -227,9 +231,9 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
#### event - jpush.receiveNotification #### event - jpush.receiveNotification
应用程序处于前台时会触发该事件 应用程序处于前台时会触发该事件。
#####代码示例 #### 代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
@@ -243,7 +247,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
alert("open Notificaiton:" + alertContent); alert("open Notificaiton:" + alertContent);
} }
+ event 举例 - event 举例
{ {
"aps":{ "aps":{
@@ -263,32 +267,24 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
##### 接口定义 ##### 接口定义
JPushPlugin.prototype.receiveMessageIniOSCallback = function(data) JPushPlugin.prototype.receiveMessageIniOSCallback(data)
##### 参数说明 ##### 参数说明
- data 是一个 js 字符串使用如下代码解析，js 具体 key 根据应用内消息来确定 - data: 是一个 js 字符串使用如下代码解析，js 具体 key 根据应用内消息来确定:
var bToObj = JSON.parse(data) var bToObj = JSON.parse(data);
#####返回值
无
##### 代码示例
## 获取自定义消息内容 ## 获取自定义消息内容
####event - jpush.receiveMessage ### event - jpush.receiveMessage
收到应用内消息时触发这个事件 收到应用内消息时触发这个事件, 推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码。
`推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码` #### 代码示例
#####代码示例
- 在你需要接收通知的的 js 文件中加入: - 在你需要接收通知的的 js 文件中加入:
@@ -296,7 +292,6 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
- onReceiveMessage 需要这样写： - onReceiveMessage 需要这样写：
var onReceiveMessage = function(event) { var onReceiveMessage = function(event) {
try{ try{
var message; var message;
@@ -308,7 +303,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
} }
+ event 举例 - event 举例:
{ {
"content":"今天去哪儿", "content":"今天去哪儿",
@@ -318,214 +313,222 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
} }
} }
### 设置Badge ## 设置Badge
#### API - setBadge, resetBadge ### API - setBadge, resetBadge
JPush 封装 badge 功能，允许应用上传 badge 值至 JPush 服务器，由 JPush 后台帮助管理每个用户所对应的推送 badge 值，简化了设置推送 badge 的操作。 JPush 封装 badge 功能，允许应用上传 badge 值至 JPush 服务器，
由 JPush 后台帮助管理每个用户所对应的推送 badge 值，简化了设置推送 badge 的操作。
（本接口不会直接改变应用本地的角标值. 要修改本地 badege 值，使用 setApplicationIconBadgeNumber） （本接口不会直接改变应用本地的角标值. 要修改本地 badege 值，使用 setApplicationIconBadgeNumber）
实际应用中，开发者可以直接对 badge 值做增减操作，无需自己维护用户与 badge 值之间的对应关系。 实际应用中，开发者可以直接对 badge 值做增减操作，无需自己维护用户与 badge 值之间的对应关系。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.setBadge(value) window.plugins.jPushPlugin.prototype.setBadge(value)
window.plugins.jPushPlugin.prototype.reSetBadge() window.plugins.jPushPlugin.prototype.reSetBadge()
`resetBadge相当于setBadge(0)` resetBadge相当于setBadge(0)。
##### 参数说明
value 取值范围：[0,99999] #### 参数说明
##### 返回值 value 取值范围：[0,99999]。
无，控制台会有 log 打印设置结果
#####代码示例 #### 返回值
无，控制台会有 log 打印设置结果。
#### 代码示例
window.plugins.jPushPlugin.setBadge(5); window.plugins.jPushPlugin.setBadge(5);
window.plugins.jPushPlugin.reSetBadge(); window.plugins.jPushPlugin.reSetBadge();
#### API - setApplicationIconBadgeNumber ### API - setApplicationIconBadgeNumber
本接口直接改变应用本地的角标值. 本接口直接改变应用本地的角标值，设置 iOS 的角标，当设置 badge ＝ 0 时为清除角标。
设置 iOS 的角标，当设置 badge ＝ 0 时为清除角标
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.setApplicationIconBadgeNumber(badge) window.plugins.jPushPlugin.prototype.setApplicationIconBadgeNumber(badge)
##### 参数说明 #### 参数说明
- badge 整形,例如0，1，2 - badge: 整形，例如 0，1，2（当 badge 为 0 时，角标被清除）。
- 当 badge 为 0 时，角标被清除
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0); window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0);
### API - getApplicationIconBadgeNumber
#### API - getApplicationIconBadgeNumber 获取 iOS 的角标值。
获取 iOS 的角标值 #### 接口定义
##### 接口定义
window.plugins.jPushPlugin.prototype.getApplicationIconBadgeNumber(callback) window.plugins.jPushPlugin.prototype.getApplicationIconBadgeNumber(callback)
##### 参数说明 #### 参数说明
- callback 回调函数 - callback: 回调函数。
#####代码示例 #### 代码示例
```
window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data) { window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data) {
console.log(data); console.log(data);
}); });
```
### 本地通知 ## 本地通知
#### API - addLocalNotificationForIOS
API 用于注册本地通知 ### API - addLocalNotificationForIOS
最多支持64个 用于注册本地通知，最多支持64个。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.addLocalNotificationForIOS(delayTime, content, badge, notificationID, extras) window.plugins.jPushPlugin.prototype.addLocalNotificationForIOS(delayTime, content, badge, notificationID, extras)
##### 参数说明 #### 参数说明
- delayTime 本地推送延迟多长时间后显示，数值类型或纯数字的字符型均可 - delayTime: 本地推送延迟多长时间后显示，数值类型或纯数字的字符型均可。
- content 本地推送需要显示的内容 - content: 本地推送需要显示的内容。
- badge 角标的数字。如果不需要改变角标传-1。数值类型或纯数字的字符型均可 - badge: 角标的数字。如果不需要改变角标传-1。数值类型或纯数字的字符型均可。
- notificationID 本地推送标识符,字符串。 - notificationID: 本地推送标识符,字符串。
- extras 自定义参数，可以用来标识推送和增加附加信息。字典类型。 - extras: 自定义参数，可以用来标识推送和增加附加信息。字典类型。
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.addLocalNotificationForIOS(6*60*60, "本地推送内容", 1, "notiId", {"key":"value"}); window.plugins.jPushPlugin.addLocalNotificationForIOS(6*60*60, "本地推送内容", 1, "notiId", {"key":"value"});
#### API - deleteLocalNotificationWithIdentifierKeyInIOS ### API - deleteLocalNotificationWithIdentifierKeyInIOS
API 删除本地推送定义 删除本地推送定义。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.deleteLocalNotificationWithIdentifierKeyInIOS(identifierKey) window.plugins.jPushPlugin.prototype.deleteLocalNotificationWithIdentifierKeyInIOS(identifierKey)
##### 参数说明 #### 参数说明
- identifierKey 本地推送标识符 - identifierKey: 本地推送标识符。
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS("identifier"); window.plugins.jPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS("identifier");
#### API - clearAllLocalNotifications ### API - clearAllLocalNotifications
API 清除所有本地推送对象 清除所有本地推送对象。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.clearAllLocalNotifications() window.plugins.jPushPlugin.prototype.clearAllLocalNotifications()
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.clearAllLocalNotifications(); window.plugins.jPushPlugin.clearAllLocalNotifications();
### 页面的统计
#### API - startLogPageView, stopLogPageView, beginLogPageView
本 API 用于“用户指定页面使用时长”的统计，并上报到服务器，在 Portal 上展示给开发者。页面统计集成正确，才能够获取正确的页面访问路径、访问深度（PV）的数据。 ## 页面的统计
##### 接口定义 ### API - startLogPageView, stopLogPageView, beginLogPageView
window.plugins.jPushPlugin.prototype.startLogPageView = function(pageName)
window.plugins.jPushPlugin.prototype.stopLogPageView = function(pageName)
window.plugins.jPushPlugin.prototype.beginLogPageView = function(pageName, duration)
#####参数说明
pageName 需要统计页面自定义名称
duration 自定义的页面时间 用于“用户指定页面使用时长”的统计，并上报到服务器，在 Portal 上展示给开发者。
#####调用说明 页面统计集成正确，才能够获取正确的页面访问路径、访问深度（PV）的数据。
#### 接口定义
window.plugins.jPushPlugin.prototype.startLogPageView(pageName)
window.plugins.jPushPlugin.prototype.stopLogPageView(pageName)
window.plugins.jPushPlugin.prototype.beginLogPageView(pageName, duration)
#### 参数说明
- pageName: 需要统计页面自定义名称
- duration: 自定义的页面时间
#### 调用说明
应在所有的需要统计得页面得 viewWillAppear 和 viewWillDisappear 加入 startLogPageView 和 stopLogPageView 来统计当前页面的停留时间。 应在所有的需要统计得页面得 viewWillAppear 和 viewWillDisappear 加入 startLogPageView 和 stopLogPageView 来统计当前页面的停留时间。
或者直接使用 beginLogPageView 来自定义加入页面和时间信息。 或者直接使用 beginLogPageView 来自定义加入页面和时间信息。
#####返回值说明
无 #### 代码示例
#####代码示例
window.plugins.jPushPlugin.beginLogPageView("newPage", 5); window.plugins.jPushPlugin.beginLogPageView("newPage", 5);
window.plugins.jPushPlugin.startLogPageView("onePage"); window.plugins.jPushPlugin.startLogPageView("onePage");
window.plugins.jPushPlugin.stopLogPageView("onePage"); window.plugins.jPushPlugin.stopLogPageView("onePage");
## 日志等级设置
### 日志等级设置 ### API - setDebugModeFromIos
#### API - setDebugModeFromIos
API 用于开启 Debug 模式，显示更多的日志信息
建议调试时开启这个选项，不调试的时候注释这句代码，这个函数 setLogOFF 是相反的一对 用于开启 Debug 模式，显示更多的日志信息。
##### 接口定义
建议调试时开启这个选项，不调试的时候注释这句代码，这个函数 setLogOFF 是相反的一对。
#### 接口定义
window.plugins.jPushPlugin.prototype.setDebugModeFromIos() window.plugins.jPushPlugin.prototype.setDebugModeFromIos()
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.setDebugModeFromIos(); window.plugins.jPushPlugin.setDebugModeFromIos();
#### API - setLogOFF ### API - setLogOFF
API 用来关闭日志信息（除了必要的错误信息） 用来关闭日志信息（除了必要的错误信息）。
不需要任何调试信息的时候，调用此 API（发布时建议调用此 API，用来屏蔽日志信息，节省性能消耗) 不需要任何调试信息的时候，调用此 API（发布时建议调用此 API，用来屏蔽日志信息，节省性能消耗)。
##### 接口定义 #### 接口定义
window.plugins.jPushPlugin.prototype.setLogOFF() window.plugins.jPushPlugin.prototype.setLogOFF()
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.setLogOFF(); window.plugins.jPushPlugin.setLogOFF();
#### API - setCrashLogON ### API - setCrashLogON
API 用于统计用户应用崩溃日志 用于统计用户应用崩溃日志。
如果需要统计 Log 信息，调用该接口。当你需要自己收集错误信息时，切记不要调用该接口。 如果需要统计 Log 信息，调用该接口。当你需要自己收集错误信息时，切记不要调用该接口。
#### 接口定义
##### 接口定义
window.plugins.jPushPlugin.prototype.setCrashLogON() window.plugins.jPushPlugin.prototype.setCrashLogON()
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.setCrashLogON(); window.plugins.jPushPlugin.setCrashLogON();
### 地理位置上报 ## 地理位置上报
#### API - setLocation
API 用于统计用户地理信息
##### 接口定义 ### API - setLocation
用于统计用户地理信息。
#### 接口定义
window.plugins.jPushPlugin.prototype.setLocation(latitude, longitude) window.plugins.jPushPlugin.prototype.setLocation(latitude, longitude)
##### 参数说明 #### 参数说明
- latitude 地理位置纬度，数值类型或纯数字的字符型均可 - latitude: 地理位置纬度，数值类型或纯数字的字符型均可。
- longitude 地理位置精度，数值类型或纯数字的字符型均可 - longitude: 地理位置精度，数值类型或纯数字的字符型均可。
#####代码示例 #### 代码示例
window.plugins.jPushPlugin.setLocation(39.26,115.25); window.plugins.jPushPlugin.setLocation(39.26,115.25);
### 设备平台判断 ## 设备平台判断
#### API - isPlatformIOS
API 用于区分 iOS, Android 平台，以便不同设置
##### 接口定义 ### API - isPlatformIOS
用于区分 iOS, Android 平台，以便不同设置。
#### 接口定义
window.plugins.jPushPlugin.prototype.isPlatformIOS() window.plugins.jPushPlugin.prototype.isPlatformIOS()
#####代码示例 #### 代码示例
if(window.plugins.jPushPlugin.isPlatformIOS()) { if(window.plugins.jPushPlugin.isPlatformIOS()) {
// iOS // iOS
README.md
+1
View File
@@ -1,5 +1,6 @@
## 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)
[![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)
[![release](https://img.shields.io/badge/release-2.1.3-blue.svg)](https://github.com/jpush/jpush-phonegap-plugin/releases) [![release](https://img.shields.io/badge/release-2.1.3-blue.svg)](https://github.com/jpush/jpush-phonegap-plugin/releases)
[![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)