From 706f32a972131fd39b8cc9821eb4eae3a9a7f872 Mon Sep 17 00:00:00 2001 From: Hevin <328066446@qq.com> Date: Thu, 21 Apr 2016 20:32:28 +0800 Subject: [PATCH 1/3] update doc --- API/Android_detail_api.md | 228 +++++++++++---------- API/iOS API.md | 417 +++++++++++++++++++------------------- README.md | 3 +- 3 files changed, 329 insertions(+), 319 deletions(-) diff --git a/API/Android_detail_api.md b/API/Android_detail_api.md index 5721b09..e2fe475 100644 --- a/API/Android_detail_api.md +++ b/API/Android_detail_api.md @@ -1,100 +1,109 @@ -## Android API简介 +# Android API简介 + +- [接收通知时获得通知的内容](#接收通知时获得通知的内容) +- [打开通知时获得通知的内容](#打开通知时获得通知的内容) +- [收到自定义消息时获取消息的内容](#收到自定义消息时获取消息的内容) +- [获取集成日志](#获取集成日志) +- [接收消息和点击通知事件](#接收消息和点击通知事件) +- [统计分析](#统计分析) +- [清除通知](#清除通知) +- [设置允许推送时间](#设置允许推送时间) +- [设置通知静默时间](#设置通知静默时间) +- [通知栏样式定制](#通知栏样式定制) +- [设置保留最近通知条数](#设置保留最近通知条数) +- [本地通知](#本地通知) -### 接收通知时获得通知的信息 +## 接收通知时获得通知的内容 -- 内容 - window.plugins.jPushPlugin.receiveNotification.alert; -- 标题 - window.plugins.jPushPlugin.receiveNotification.title; +- 内容: + 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.receiveNotification.extras.yourKey; + window.plugins.jPushPlugin.openNotification.extras.yourKey -### 打开通知时获得通知的信息 +## 收到自定义消息时获取消息的内容 -- 内容 - window.plugins.jPushPlugin.openNotification.alert; -- 标题 - window.plugins.jPushPlugin.openNotification.title; -- 附加字段 - window.plugins.jPushPlugin.openNotification.extras.yourKey; +- 内容: + window.plugins.jPushPlugin.receiveMessage.message +- 附加字段: + window.plugins.jPushPlugin.receiveMessage.extras.yourKey -### 收到自定义消息时获得通知的信息 +## 获取集成日志 -- 内容 - window.plugins.jPushPlugin.receiveMessage.message; -- 附加字段 - window.plugins.jPushPlugin.receiveMessage.extras.yourKey; - -### 获取集成日志 - -#### API - setDebugMode +### API - setDebugMode 用于开启调试模式,可以查看集成 JPush 过程中的 Log,如果集成失败,可方便定位问题所在。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.setDebugMode(mode) -##### 参数说明 +#### 参数说明 -- mode的值 - - - true 显示集成日志 - - false 不显示集成日志 +- mode: + - true 显示集成日志。 + - false 不显示集成日志。 -### 接收消息和点击通知事件 -#### API - receiveMessageInAndroidCallback +## 接收消息和点击通知事件 +### API - receiveMessageInAndroidCallback 用于 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 上展示给开发者。 - -####接口定义 +#### 接口定义 public static void onResume(final Activity activity) public static void onPause(final Activity activity) -####参数说明 +#### 参数说明 - + Activity 当前所在的 Activity。 + - Activity: 当前所在的 Activity。 -####调用说明 +#### 调用说明 应在所有的 Activity 的 onResume / onPause 方法里调用。 -####代码示例 +#### 代码示例 @Override protected void onResume() { @@ -108,7 +117,7 @@ JPushInterface.onPause(this); } -#### API - setStatisticsOpen(boolean) +### API - setStatisticsOpen 用于在 js 中控制是否打开应用的统计分析功能,但如果已经添加了上面的 onResume / onPause 方法, 就不能再通过这个方法来控制统计分析功能了。 @@ -119,77 +128,78 @@ #### 参数说明 -- boolean - - true : 打开统计分析功能 - - false: 关闭统计分析功能 +- boolean: + - true: 打开统计分析功能。 + - false: 关闭统计分析功能。 -#### API - reportNotificationOpened +### API - reportNotificationOpened 用于上报用户的通知栏被打开,或者用于上报用户自定义消息被展示等客户端需要统计的事件。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.reportNotificationOpened(msgID) -##### 参数说明 -- msgID - - 收到的通知或者自定义消息的 id +#### 参数说明 + +- msgID: 收到的通知或者自定义消息的 id。 -### 清除通知 API +## 清除通知 -#### API - clearAllNotification +### API - clearAllNotification 推送通知到客户端时,由 JPush SDK 展现通知到通知栏上。 此 API 提供清除通知的功能,包括:清除所有 JPush 展现的通知(不包括非 JPush SDK 展现的)。 - -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.clearAllNotification() -### 设置允许推送时间 API -#### API - setPushTime +## 设置允许推送时间 + +### API - setPushTime 默认情况下用户在任何时间都允许推送。即任何时候有推送下来,客户端都会收到,并展示。 开发者可以调用此 API 来设置允许推送的时间。 如果不在该时间段内收到消息,当前的行为是:推送到的通知会被扔掉。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.setPushTime(days, startHour, endHour) -##### 参数说明 -- days: 数组 0表示星期天,1表示星期一,以此类推。 (7天制,数组中的int范围为0到6)set的值为null, 表示任何时间都可以收到消息和通知,set的size为0,则表示任何时间都收不到消息和通知. -- startHour: int 允许推送的开始时间 (24小时制:startHour的范围为0到23) -- endHour: int 允许推送的结束时间 (24小时制:endHour的范围为0到23) +#### 参数说明 +- days: 数组,0 表示星期天,1 表示星期一,以此类推(7天制,数组中值的范围为 0 到 6 )。 +数组的值为 null, 表示任何时间都可以收到消息和通知,数组的 size 为 0,则表示任何时间都收不到消息和通知。 +- startHour: 整形,允许推送的开始时间 (24 小时制:startHour 的范围为 0 到 23)。 +- endHour: 整形,允许推送的结束时间 (24 小时制:endHour 的范围为 0 到 23)。 -### 设置通知静默时间 API +## 设置通知静默时间 -#### API - setSilenceTime -默认情况下用户在收到推送通知时,客户端可能会有震动,响铃等提示。但用户在睡觉、开会等时间点希望为 "免打扰" 模式,也是静音时段的概念。 +### API - setSilenceTime +默认情况下用户在收到推送通知时,客户端可能会有震动,响铃等提示。 +但用户在睡觉、开会等时间点希望为 "免打扰" 模式,也是静音时段的概念。 开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息,则:不会有铃声和震动。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.setSilenceTime(startHour, startMinute, endHour, endMinute) -##### 参数说明 +#### 参数说明 -- startHour: int 静音时段的开始时间 - 小时 (24小时制,范围:0~23 ) -- startMinute: int 静音时段的开始时间 - 分钟(范围:0~59 ) -- endHour: 静音时段的结束时间 - 小时 (24小时制,范围:0~23 ) -- endMinute: 静音时段的结束时间 - 分钟(范围:0~59 ) +- startHour: 整形,静音时段的开始时间 - 小时 (24小时制,范围:0~23 )。 +- startMinute: 整形,静音时段的开始时间 - 分钟(范围:0~59 )。 +- endHour: 整形,静音时段的结束时间 - 小时 (24小时制,范围:0~23 )。 +- endMinute: 整形,静音时段的结束时间 - 分钟(范围:0~59 )。 -### 通知栏样式定制 API +## 通知栏样式定制 - -#### API - setBasicPushNotificationBuilder, setCustomPushNotificationBuilder +### API - setBasicPushNotificationBuilder, setCustomPushNotificationBuilder 当用户需要定制默认的通知栏样式时,则可调用此方法。 -极光 Push SDK 提供了 2 个用于定制通知栏样式的构建类: +JPush SDK 提供了 2 个用于定制通知栏样式的构建类: - setBasicPushNotificationBuilder - Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)。 @@ -198,34 +208,31 @@ 如果不调用此方法定制,则极光 Push SDK 默认的通知栏样式是:Android 标准的通知栏提示。 -##### 接口定义 +#### 接口定义 - window.plugins.jPushPlugin.setBasicPushNotificationBuilder = function() - window.plugins.jPushPlugin.setCustomPushNotificationBuilder = function() + window.plugins.jPushPlugin.setBasicPushNotificationBuilder() + window.plugins.jPushPlugin.setCustomPushNotificationBuilder() -### 设置保留最近通知条数 API +## 设置保留最近通知条数 -#### API - setLatestNotificationNum +### API - setLatestNotificationNum 通过极光推送,推送了很多通知到客户端时,如果用户不去处理,就会有很多保留在那里。 -新版本 SDK (v1.3.0) 增加此功能,限制保留的通知条数。默认为保留最近 5 条通知。 +默认为保留最近 5 条通知,开发者可通过调用此 API 来定义为不同的数量。 -开发者可通过调用此 API 来定义为不同的数量。 - -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.setLatestNotificationNum(num) -##### 参数说明 +#### 参数说明 -- num 保存的条数 +- num: 保存的条数。 -### 本地通知 API -#### API - addLocalNotification,removeLocalNotification,clearLocalNotifications - +## 本地通知 +### API - addLocalNotification, removeLocalNotification, clearLocalNotifications 本地通知 API 不依赖于网络,无网条件下依旧可以触发。 @@ -233,21 +240,20 @@ 本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响。 - 三个接口的功能分别为:添加一个本地通知,删除一个本地通知,删除所有的本地通知。 #####接口定义 - window.plugins.jPushPlugin.addLocalNotification = function(builderId, - content, title, notificaitonID, broadcastTime, extras) - window.plugins.jPushPlugin.removeLocalNotification = function(notificationID) - window.plugins.jPushPlugin.clearLocalNotifications = function() + window.plugins.jPushPlugin.addLocalNotification(builderId, content, title, + notificaitonID, broadcastTime, extras) + window.plugins.jPushPlugin.removeLocalNotification(notificationID) + window.plugins.jPushPlugin.clearLocalNotifications() -##### 参数说明 +#### 参数说明 -- 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/API/iOS API.md b/API/iOS API.md index ff5477f..0491ccc 100644 --- a/API/iOS API.md +++ b/API/iOS API.md @@ -1,21 +1,32 @@ -## iOS API +# iOS API + +- [开始与停止推送服务](#开始与停止推送服务) +- [获取 RegistrationID](#获取-registrationid) +- [别名与标签](#别名与标签) +- [获取 APNS 推送内容](#获取-apns-推送内容) + - [点击推送获取](#点击推送获取) + - [前台获取](#前台获取) +- [获取自定义消息内容](#获取自定义消息内容) +- [设置Badge](#设置badge) +- [本地通知](#本地通知) +- [页面的统计](#页面的统计) +- [日志等级设置](#日志等级设置) +- [地理位置上报](#地理位置上报) +- [设备平台判断](#设备平台判断) + +## 开始与停止推送服务 -## 开始与停止推送服务 API ### API - init -调用此 API,用来开启 -JPush SDK 提供的推送服务。 +调用此 API,用来开启 JPush SDK 提供的推送服务。 -开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 +开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务,当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 ``` 本功能是一个完全本地的状态操作。也就是说:停止推送服务的状态不会保存到服务器上。 - 如果停止推送服务后,开发者 App 被重新安装,或者被清除数据, - JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数据被清除掉了)。 本功能其行为类似于网络中断的效果,即:推送服务停止期间推送的消息, - 恢复推送服务后,如果推送的消息还在保留的时长范围内,则客户端是会收到离线消息。 ``` @@ -23,43 +34,43 @@ JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数 window.plugins.jPushPlugin.init() + ### API - stopPush -+ 不推荐调用,因为这个 API 只是让你的 DeviceToken 失效,在 设置-通知 中您的应用程序没有任何变化 -+ 推荐:设置一个 UI 界面, 提醒用户在 设置-通知 中关闭推送服务 +- 不推荐调用,因为这个 API 只是让你的 DeviceToken 失效,在 设置-通知 中您的应用程序没有任何变化。 +- 推荐:设置一个 UI 界面,提醒用户在 设置-通知 中关闭推送服务。 -### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.stopPush() -#### API - resumePush +### API - resumePush +恢复推送服务。调用了此 API 后,iOS平台,重新去APNS注册。 -恢复推送服务。调用了此 API 后,iOS平台,重新去APNS注册 - - -##### 接口定义 +#### 接口定义 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) var onCallback = function(data) { - if(data > 0){ + if(data > 0) { // 开启 } else { // 关闭 @@ -67,11 +78,11 @@ iOS平台,检查推送服务是否注册 } -##获取 RegistrationID API +## 获取 RegistrationID ### API - getRegistrationID -RegistrationID 定义 +RegistrationID 定义: 集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时,JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。 JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 @@ -80,26 +91,24 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 #### 接口定义 - JPushPlugin.prototype.getRegistrationID = function(callback) + JPushPlugin.prototype.getRegistrationID(callback) -##### 参数说明 -无 #### 返回值 -调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值,否则返回空字符串。 +调用此 API 来取得应用程序对应的 RegistrationID。只有当应用程序成功注册到 JPush 的服务器时才返回对应的值,否则返回空字符串。 #### 调用示例 window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID); var onGetRegistradionID = function(data) { try { - console.log("JPushPlugin:registrationID is " + data) + console.log("JPushPlugin:registrationID is " + data); } catch(exception) { console.log(exception); } } -##别名与标签 API +## 别名与标签 ### API - setTagsWithAlias, setTags, setAlias @@ -127,63 +136,60 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 不同应用程序、不同的用户,可以打同样的标签。 -举例: game, old_page, women +举例: game, old_page, women。 #### 接口定义 - JPushPlugin.prototype.setTagsWithAlias = function(tags, alias) - JPushPlugin.prototype.setTags = function(tags) - JPushPlugin.prototype.setAlias = function(alias) + JPushPlugin.prototype.setTagsWithAlias(tags, alias) + JPushPlugin.prototype.setTags(tags) + JPushPlugin.prototype.setAlias(alias) #### 参数说明 -* tags - * 参数类型为数组 - * nil 此次调用不设置此值 - * 空集合表示取消之前的设置 - * 每次调用至少设置一个 tag,覆盖之前的设置,不是新增 - * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字 - * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 100 个 tag,但总长度不得超过1K字节。(判断长度需采用UTF-8编码) +* tags: + * 参数类型为数组。 + * nil 此次调用不设置此值。 + * 空集合表示取消之前的设置。 + * 每次调用至少设置一个 tag,覆盖之前的设置,不是新增。 + * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字。 + * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 100 个 tag,但总长度不得超过1K字节(判断长度需采用UTF-8编码)。 * 单个设备最多支持设置 100 个 tag,App 全局 tag 数量无限制。 -* alias - * 参数类型为字符串 - * nil 此次调用不设置此值 - * 空字符串 ("")表示取消之前的设置 +* alias: + * 参数类型为字符串。 + * nil 此次调用不设置此值。 + * 空字符串 ("")表示取消之前的设置。 * 有效的别名组成:字母(区分大小写)、数字、下划线、汉字。 - * 限制:alias 命名长度限制为 40 字节。(判断长度需采用 UTF-8 编码) + * 限制:alias 命名长度限制为 40 字节(判断长度需采用 UTF-8 编码)。 #### 返回值说明 -函数本身无返回值,但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果 +函数本身无返回值,但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果。 document.addEventListener("jpush.setTagsWithAlias", onTagsWithAlias, false); var onTagsWithAlias = function(event) { - try { + try { console.log("onTagsWithAlias"); var result = "result code:"+event.resultCode + " "; result += "tags:" + event.tags + " "; result += "alias:" + event.alias + " "; $("#tagAliasResult").html(result); - } catch(exception) { + } catch(exception) { console.log(exception) - } - } - -####错误码定义 - - + } + } +#### 错误码定义 |Code|描述 |详细解释 | |----|:----------------------------------------|:--------| |6001|无效的设置,tag/alias 不应参数都为 null | | -|6002|设置超时 |建议重试| +|6002|设置超时 |建议重试。| |6003|alias 字符串不合法 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| -|6004|alias超长。 |最多 40个字节 中文 UTF-8 是 3 个字节| +|6004|alias超长 |最多 40个字节 中文 UTF-8 是 3 个字节。| |6005|某一个 tag 字符串不合法 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| -|6006|某一个 tag 超长 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节| -|6007|tags 数量超出限制。最多 100个 |这是一台设备的限制。一个应用全局的标签数量无限制。| -|6008|tag/alias 超出总长度限制 |总长度最多 1K 字节| -|6011|10s内设置tag或alias大于3次 |短时间内操作过于频繁| +|6006|某一个 tag 超长 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节。| +|6007|tags 数量超出限制(最多 100 个) |这是一台设备的限制。一个应用全局的标签数量无限制。| +|6008|tag/alias 超出总长度限制 |总长度最多 1K 字节。| +|6011|10s内设置tag或alias大于3次 |短时间内操作过于频繁。| ## 获取 APNS 推送内容 @@ -192,16 +198,15 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 #### event - jpush.openNotification -点击通知进入应用程序时会出发改事件 +点击通知进入应用程序时会出发改事件。 -#####代码示例 +#### 代码示例 - 在你需要接收通知的的 js 文件中加入: document.addEventListener("jpush.openNotification", onOpenNotification, false); -- onOpenNotification需要这样写: - +- onOpenNotification 需要这样写: var onOpenNotification = function(event) { var alertContent; @@ -209,27 +214,26 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 alert("open Notificaiton:" + alertContent); } - -+ event 举例 +- event 举例: { - "aps":{ - "badge":1, - "sound":"default", - "alert":"今天去哪儿" - }, - "key1":"value1", - "key2":"value2", - "_j_msgid":154604475 + "aps":{ + "badge":1, + "sound":"default", + "alert":"今天去哪儿" + }, + "key1":"value1", + "key2":"value2", + "_j_msgid":154604475 } ### 前台获取 #### event - jpush.receiveNotification -应用程序处于前台时会触发该事件 +应用程序处于前台时会触发该事件。 -#####代码示例 +#### 代码示例 - 在你需要接收通知的的 js 文件中加入: @@ -243,17 +247,17 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 alert("open Notificaiton:" + alertContent); } -+ event 举例 +- event 举例 { - "aps":{ - "badge":1, - "sound":"default", - "alert":"今天去哪儿" - }, - "key1":"value1", - "key2":"value2", - "_j_msgid":154604475 + "aps":{ + "badge":1, + "sound":"default", + "alert":"今天去哪儿" + }, + "key1":"value1", + "key2":"value2", + "_j_msgid":154604475 } #### API - receiveMessageIniOSCallback @@ -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 文件中加入: @@ -296,7 +292,6 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 - onReceiveMessage 需要这样写: - var onReceiveMessage = function(event) { try{ var message; @@ -308,7 +303,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 } -+ event 举例 +- event 举例: { "content":"今天去哪儿", @@ -318,217 +313,225 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 } } -### 设置Badge -#### API - setBadge, resetBadge +## 设置Badge +### API - setBadge, resetBadge - JPush 封装 badge 功能,允许应用上传 badge 值至 JPush 服务器,由 JPush 后台帮助管理每个用户所对应的推送 badge 值,简化了设置推送 badge 的操作。 + JPush 封装 badge 功能,允许应用上传 badge 值至 JPush 服务器, + 由 JPush 后台帮助管理每个用户所对应的推送 badge 值,简化了设置推送 badge 的操作。 (本接口不会直接改变应用本地的角标值. 要修改本地 badege 值,使用 setApplicationIconBadgeNumber) 实际应用中,开发者可以直接对 badge 值做增减操作,无需自己维护用户与 badge 值之间的对应关系。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.setBadge(value) window.plugins.jPushPlugin.prototype.reSetBadge() -`resetBadge相当于setBadge(0)` -##### 参数说明 -value 取值范围:[0,99999] -##### 返回值 -无,控制台会有 log 打印设置结果 -#####代码示例 +resetBadge相当于setBadge(0)。 + +#### 参数说明 +value 取值范围:[0,99999]。 + +#### 返回值 +无,控制台会有 log 打印设置结果。 + +#### 代码示例 window.plugins.jPushPlugin.setBadge(5); window.plugins.jPushPlugin.reSetBadge(); -#### API - setApplicationIconBadgeNumber +### API - setApplicationIconBadgeNumber -本接口直接改变应用本地的角标值. -设置 iOS 的角标,当设置 badge = 0 时为清除角标 +本接口直接改变应用本地的角标值,设置 iOS 的角标,当设置 badge = 0 时为清除角标。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.setApplicationIconBadgeNumber(badge) -##### 参数说明 +#### 参数说明 -- badge 整形,例如0,1,2 -- 当 badge 为 0 时,角标被清除 +- badge: 整形,例如 0,1,2(当 badge 为 0 时,角标被清除)。 -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0); +### API - getApplicationIconBadgeNumber -#### API - getApplicationIconBadgeNumber +获取 iOS 的角标值。 -获取 iOS 的角标值 - -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.getApplicationIconBadgeNumber(callback) -##### 参数说明 +#### 参数说明 -- callback 回调函数 +- callback: 回调函数。 -#####代码示例 -``` +#### 代码示例 -window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data){ - console.log(data); - }); + window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data) { + console.log(data); + }); -``` -### 本地通知 -#### API - addLocalNotificationForIOS +## 本地通知 -API 用于注册本地通知 +### API - addLocalNotificationForIOS -最多支持64个 +用于注册本地通知,最多支持64个。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.addLocalNotificationForIOS(delayTime, content, badge, notificationID, extras) -##### 参数说明 +#### 参数说明 -- delayTime 本地推送延迟多长时间后显示,数值类型或纯数字的字符型均可 -- content 本地推送需要显示的内容 -- badge 角标的数字。如果不需要改变角标传-1。数值类型或纯数字的字符型均可 -- notificationID 本地推送标识符,字符串。 -- extras 自定义参数,可以用来标识推送和增加附加信息。字典类型。 +- delayTime: 本地推送延迟多长时间后显示,数值类型或纯数字的字符型均可。 +- content: 本地推送需要显示的内容。 +- badge: 角标的数字。如果不需要改变角标传-1。数值类型或纯数字的字符型均可。 +- notificationID: 本地推送标识符,字符串。 +- extras: 自定义参数,可以用来标识推送和增加附加信息。字典类型。 -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.addLocalNotificationForIOS(6*60*60, "本地推送内容", 1, "notiId", {"key":"value"}); -#### API - deleteLocalNotificationWithIdentifierKeyInIOS +### API - deleteLocalNotificationWithIdentifierKeyInIOS -API 删除本地推送定义 +删除本地推送定义。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.deleteLocalNotificationWithIdentifierKeyInIOS(identifierKey) -##### 参数说明 +#### 参数说明 -- identifierKey 本地推送标识符 +- identifierKey: 本地推送标识符。 -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS("identifier"); -#### API - clearAllLocalNotifications +### API - clearAllLocalNotifications -API 清除所有本地推送对象 +清除所有本地推送对象。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.clearAllLocalNotifications() -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.clearAllLocalNotifications(); - -### 页面的统计 -#### API - startLogPageView, stopLogPageView, beginLogPageView -本 API 用于“用户指定页面使用时长”的统计,并上报到服务器,在 Portal 上展示给开发者。页面统计集成正确,才能够获取正确的页面访问路径、访问深度(PV)的数据。 -##### 接口定义 - window.plugins.jPushPlugin.prototype.startLogPageView = function(pageName) - window.plugins.jPushPlugin.prototype.stopLogPageView = function(pageName) - window.plugins.jPushPlugin.prototype.beginLogPageView = function(pageName, duration) -#####参数说明 -pageName 需要统计页面自定义名称 +## 页面的统计 -duration 自定义的页面时间 -#####调用说明 +### API - startLogPageView, stopLogPageView, beginLogPageView + +用于“用户指定页面使用时长”的统计,并上报到服务器,在 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 来统计当前页面的停留时间。 - 或者直接使用 beginLogPageView 来自定义加入页面和时间信息。 -#####返回值说明 -无 -#####代码示例 +或者直接使用 beginLogPageView 来自定义加入页面和时间信息。 + +#### 代码示例 window.plugins.jPushPlugin.beginLogPageView("newPage", 5); window.plugins.jPushPlugin.startLogPageView("onePage"); window.plugins.jPushPlugin.stopLogPageView("onePage"); - -### 日志等级设置 -#### API - setDebugModeFromIos -API 用于开启 Debug 模式,显示更多的日志信息 +## 日志等级设置 -建议调试时开启这个选项,不调试的时候注释这句代码,这个函数 setLogOFF 是相反的一对 -##### 接口定义 +### API - setDebugModeFromIos + +用于开启 Debug 模式,显示更多的日志信息。 + +建议调试时开启这个选项,不调试的时候注释这句代码,这个函数 setLogOFF 是相反的一对。 + +#### 接口定义 window.plugins.jPushPlugin.prototype.setDebugModeFromIos() -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.setDebugModeFromIos(); -#### API - setLogOFF +### API - setLogOFF -API 用来关闭日志信息(除了必要的错误信息) +用来关闭日志信息(除了必要的错误信息)。 -不需要任何调试信息的时候,调用此 API(发布时建议调用此 API,用来屏蔽日志信息,节省性能消耗) +不需要任何调试信息的时候,调用此 API(发布时建议调用此 API,用来屏蔽日志信息,节省性能消耗)。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.setLogOFF() -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.setLogOFF(); -#### API - setCrashLogON +### API - setCrashLogON -API 用于统计用户应用崩溃日志 +用于统计用户应用崩溃日志。 如果需要统计 Log 信息,调用该接口。当你需要自己收集错误信息时,切记不要调用该接口。 - -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.prototype.setCrashLogON() -#####代码示例 +#### 代码示例 window.plugins.jPushPlugin.setCrashLogON(); -### 地理位置上报 -#### API - setLocation -API 用于统计用户地理信息 +## 地理位置上报 -##### 接口定义 +### API - setLocation -window.plugins.jPushPlugin.prototype.setLocation(latitude,longitude) +用于统计用户地理信息。 -##### 参数说明 +#### 接口定义 -- latitude 地理位置纬度,数值类型或纯数字的字符型均可 -- longitude 地理位置精度,数值类型或纯数字的字符型均可 + window.plugins.jPushPlugin.prototype.setLocation(latitude, longitude) -#####代码示例 +#### 参数说明 -window.plugins.jPushPlugin.setLocation(39.26,115.25); +- latitude: 地理位置纬度,数值类型或纯数字的字符型均可。 +- longitude: 地理位置精度,数值类型或纯数字的字符型均可。 -### 设备平台判断 -#### API - isPlatformIOS -API 用于区分 iOS, Android 平台,以便不同设置 +#### 代码示例 -##### 接口定义 + window.plugins.jPushPlugin.setLocation(39.26,115.25); + +## 设备平台判断 + +### API - isPlatformIOS + +用于区分 iOS, Android 平台,以便不同设置。 + +#### 接口定义 window.plugins.jPushPlugin.prototype.isPlatformIOS() -#####代码示例 +#### 代码示例 - if(window.plugins.jPushPlugin.isPlatformIOS()){ + if(window.plugins.jPushPlugin.isPlatformIOS()) { // iOS - }else{ + } else { // Android } diff --git a/README.md b/README.md index 06ac372..3375bb4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ ## 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) [![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) @@ -18,7 +19,7 @@ JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。 *如需要 IM 功能插件,请关注 [jmessage-phonegap-plugin](https://github.com/jpush/jmessage-phonegap-plugin)*。 -## 安装 +## 安装 ### 准备工作 1. cordova create 文件夹名字 包名 应用名字 From 8241b364cc5cae7fc72f7c6d4202bd8b2bcd99b6 Mon Sep 17 00:00:00 2001 From: Hevin <328066446@qq.com> Date: Fri, 22 Apr 2016 11:22:07 +0800 Subject: [PATCH 2/3] format doc --- API/Common_detail_api.md | 382 +++++++++++++++++++-------------------- README.md | 92 +++++----- 2 files changed, 235 insertions(+), 239 deletions(-) diff --git a/API/Common_detail_api.md b/API/Common_detail_api.md index e460001..1c10148 100644 --- a/API/Common_detail_api.md +++ b/API/Common_detail_api.md @@ -1,7 +1,14 @@ -#通用 API 说明 +# 通用 API 说明 + +- [停止与恢复推送服务](#停止与恢复推送服务) +- [获取 RegistrationID](#获取-registrationid) +- [别名与标签 API](#别名与标签-api) +- [获取点击通知内容](#获取点击通知内容) +- [获取通知内容](#获取通知内容) +- [获取自定义消息推送内容](#获取自定义消息推送内容) -## 停止与恢复推送服务 API +## 停止与恢复推送服务 ### API - init 调用此 API,用来开启 @@ -9,87 +16,80 @@ JPush SDK 提供的推送服务。 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 -``` 本功能是一个完全本地的状态操作。也就是说:停止推送服务的状态不会保存到服务器上。 如果停止推送服务后,开发者 App 被重新安装,或者被清除数据, - JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数据被清除掉了)。 -本功能其行为类似于网络中断的效果,即:推送服务停止期间推送的消息, +本功能其行为类似于网络中断的效果,即:推送服务停止期间推送的消息, 恢复推送服务后,如果推送的消息还在保留的时长范围内,则客户端是会收到离线消息。 -``` #### 接口定义 window.plugins.jPushPlugin.init() ### API - stopPush -+ 在 Android 平台 ++ Android 平台: + 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务,当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 + + 调用了本 API 后,JPush 推送服务完全被停止,具体表现为: - + 调用了本 API 后,JPush 推送服务完全被停止。具体表现为: + + JPush Service 不在后台运行。 + + 收不到推送消息。 + + 不能通过 JPushInterface.init 恢复,需要调用 resumePush 恢复。 + + 极光推送所有的其他 API 调用都无效。 - + JPush Service 不在后台运行 - + 收不到推送消息 - + 不能通过 JPushInterface.init 恢复,需要调用 resumePush 恢复 - + 极光推送所有的其他 API 调用都无效 ++ iOS 平台: -+ iOS 平台 + + 不推荐调用,因为这个 API 只是让你的 DeviceToken 失效,在 设置-通知 中您的应用程序没有任何变化。 + + 推荐:设置一个 UI 界面, 提醒用户在 设置-通知 中关闭推送服务。 - + 不推荐调用,因为这个 API 只是让你的 DeviceToken 失效,在 设置-通知 中您的应用程序没有任何变化 - + 推荐:设置一个 UI 界面, 提醒用户在 设置-通知 中关闭推送服务 - -### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.stopPush() -#### API - resumePush +### API - resumePush +恢复推送服务。调用了此 API 后: -恢复推送服务。调用了此 API 后 ++ Android 平台: -+ 在 Android 平台 + + 极光推送完全恢复正常工作。 - + 极光推送完全恢复正常工作, ++ iOS 平台: -+ iOS平台 + + 重新去APNS注册。 - + 重新去APNS注册 - - - -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.resumePush() -#### API - isPushStopped +### API - isPushStopped -+ 在 Android 平台 ++ Android 平台: - + 用来检查 Push Service 是否已经被停止 + + 用来检查 Push Service 是否已经被停止。 -+ iOS平台 ++ iOS 平台: - + 平台检查推送服务是否注册 + + 平台检查推送服务是否注册。 -##### 接口定义 +#### 接口定义 window.plugins.jPushPlugin.isPushStopped(callback) +#### 参数说明 -##### 参数说明 ++ callback: 回调函数,用来通知 JPush 的推送服务是否开启。 -+ callback 回调函数,用来通知 JPush 的推送服务是否开启 +#### 代码示例 -####代码示例 window.plugins.jPushPlugin.resumePush(callback) var onCallback = function(data) { - if(data > 0){ + if(data > 0) { // 开启 } else { // 关闭 @@ -97,11 +97,11 @@ JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数 } -##获取 RegistrationID API +## 获取 RegistrationID ### API - getRegistrationID -RegistrationID 定义 +RegistrationID 定义: 集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时,JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。 JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 @@ -110,26 +110,24 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 #### 接口定义 - JPushPlugin.prototype.getRegistrationID = function(callback) + JPushPlugin.prototype.getRegistrationID(callback) -##### 参数说明 -无 #### 返回值 调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值,否则返回空字符串。 -#### 调用示例 +#### 代码示例 window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID); var onGetRegistradionID = function(data) { try { - console.log("JPushPlugin:registrationID is " + data) + console.log("JPushPlugin:registrationID is " + data); } catch(exception) { console.log(exception); } } -##别名与标签 API +## 别名与标签 API ### API - setTagsWithAlias, setTags, setAlias @@ -137,7 +135,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 这几个 API 可以在 App 里任何地方调用。 -**别名 Alias** +**别名 Alias**: 为安装了应用程序的用户,取个别名来标识。以后给该用户 Push 消息时,就可以用此别名来指定。 @@ -149,7 +147,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 举例:在一个用户要登录的游戏中,可能设置别名为 userid。游戏运营时,发现该用户 3 天没有玩游戏了,则根据 userid 调用服务器端 API 发通知到客户端提醒用户。 -**标签 Tag** +**标签 Tag**: 为安装了应用程序的用户,打上标签。其目的主要是方便开发者根据标签,来批量下发 Push 消息。 @@ -157,177 +155,178 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 不同应用程序、不同的用户,可以打同样的标签。 -举例: game, old_page, women +举例: game, old_page, women。 #### 接口定义 - JPushPlugin.prototype.setTagsWithAlias = function(tags, alias) - JPushPlugin.prototype.setTags = function(tags) - JPushPlugin.prototype.setAlias = function(alias) + JPushPlugin.prototype.setTagsWithAlias(tags, alias) + JPushPlugin.prototype.setTags(tags) + JPushPlugin.prototype.setAlias(alias) #### 参数说明 -* tags - * 参数类型为数组 - * nil 此次调用不设置此值 - * 空集合表示取消之前的设置 - * 每次调用至少设置一个 tag,覆盖之前的设置,不是新增 - * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字 - * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 100 个 tag,但总长度不得超过1K字节。(判断长度需采用UTF-8编码) +* tags: + * 参数类型为数组。 + * nil 此次调用不设置此值。 + * 空集合表示取消之前的设置。 + * 每次调用至少设置一个 tag,覆盖之前的设置,不是新增。 + * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字。 + * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 100 个 tag,但总长度不得超过1K字节(判断长度需采用 UTF-8 编码)。 * 单个设备最多支持设置 100 个 tag,App 全局 tag 数量无限制。 -* alias - * 参数类型为字符串 - * nil 此次调用不设置此值 - * 空字符串 ("")表示取消之前的设置 +* alias: + * 参数类型为字符串。 + * nil 此次调用不设置此值。 + * 空字符串 ("")表示取消之前的设置。 * 有效的别名组成:字母(区分大小写)、数字、下划线、汉字。 - * 限制:alias 命名长度限制为 40 字节。(判断长度需采用 UTF-8 编码) + * 限制:alias 命名长度限制为 40 字节(判断长度需采用 UTF-8 编码)。 #### 返回值说明 -函数本身无返回值,但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果 +函数本身无返回值,但需要注册 `jpush.setTagsWithAlias` 事件来监听设置结果: document.addEventListener("jpush.setTagsWithAlias", onTagsWithAlias, false); var onTagsWithAlias = function(event) { - try { - console.log("onTagsWithAlias"); - var result = "result code:"+event.resultCode + " "; - result += "tags:" + event.tags + " "; - result += "alias:" + event.alias + " "; - $("#tagAliasResult").html(result); - } catch(exception) { - console.log(exception) - } - } - -####错误码定义 - - + try { + console.log("onTagsWithAlias"); + var result = "result code:" + event.resultCode + " "; + result += "tags:" + event.tags + " "; + result += "alias:" + event.alias + " "; + $("#tagAliasResult").html(result); + } catch(exception) { + console.log(exception); + } + } +#### 错误码定义 |Code|描述 |详细解释 | |----|:----------------------------------------|:--------| -|6001|无效的设置,tag/alias 不应参数都为 null | | -|6002|设置超时 |建议重试| -|6003|alias 字符串不合法 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| -|6004|alias超长。 |最多 40个字节 中文 UTF-8 是 3 个字节| -|6005|某一个 tag 字符串不合法 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| -|6006|某一个 tag 超长 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节| -|6007|tags 数量超出限制。最多 100个 |这是一台设备的限制。一个应用全局的标签数量无限制。| -|6008|tag/alias 超出总长度限制 |总长度最多 1K 字节| -|6011|10s内设置tag或alias大于3次 |短时间内操作过于频繁| +|6001|无效的设置,tag / alias 不应参数都为 null。 | | +|6002|设置超时。 |建议重试。| +|6003|alias 字符串不合法。 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| +|6004|alias超长。 |最多 40个字节,中文 UTF-8 是 3 个字节。| +|6005|某一个 tag 字符串不合法。 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| +|6006|某一个 tag 超长。 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节。| +|6007|tags 数量超出限制,最多 100 个。 |这是一台设备的限制。一个应用全局的标签数量无限制。| +|6008|tag / alias 超出总长度限制。 |总长度最多 1K 字节。| +|6011|10s内设置 tag 或 alias 大于 3 次。 |短时间内操作过于频繁。| -### 获取点击通知内容 +## 获取点击通知内容 -#### event - jpush.openNotification +### event - jpush.openNotification -点击通知进入应用程序时会出发改事件 +点击通知进入应用程序时会出发改事件。 -#####代码示例 +#### 代码示例 - 在你需要接收通知的的 js 文件中加入: document.addEventListener("jpush.openNotification", onOpenNotification, false); -- onOpenNotification需要这样写: +- onOpenNotification 需要这样写: + var alertContent; + if(device.platform == "Android") { + alertContent = window.plugins.jPushPlugin.openNotification.alert; + } else { + alertContent = event.aps.alert; + } + alert("open Notificaiton:" + alertContent); - var alertContent; - if(device.platform == "Android"){ - alertContent = window.plugins.jPushPlugin.openNotification.alert; - }else{ - alertContent = event.aps.alert; - } - alert("open Notificaiton:" + alertContent); +ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.openNotification,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意。 -ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.openNotification,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意 - -+ Android - - {"alert":"ding", - "extras":{ - "cn.jpush.android.MSG_ID":"1691785879", - "app":"com.thi.pushtest", - "cn.jpush.android.ALERT":"ding", - "cn.jpush.android.EXTRA":{}, - "cn.jpush.android.PUSH_ID":"1691785879", - "cn.jpush.android.NOTIFICATION_ID":1691785879, - "cn.jpush.android.NOTIFICATION_TYPE":"0"}} - -+ iOS ++ Android: { - "aps":{ - "badge":1, - "sound":"default", - "alert":"今天去哪儿" - }, - "key1":"value1", - "key2":"value2", - "_j_msgid":154604475 + "title": "title", + "alert":"ding", + "extras":{ + "yourKey": "yourValue", + "cn.jpush.android.MSG_ID": "1691785879", + "app": "com.thi.pushtest", + "cn.jpush.android.ALERT": "ding", + "cn.jpush.android.EXTRA": {}, + "cn.jpush.android.PUSH_ID": "1691785879", + "cn.jpush.android.NOTIFICATION_ID": 1691785879, + "cn.jpush.android.NOTIFICATION_TYPE": "0" + } } -### 获取通知内容 ++ iOS: -#### event - jpush.receiveNotification + { + "aps":{ + "badge": 1, + "sound": "default", + "alert": "今天去哪儿" + }, + "key1": "value1", + "key2": "value2", + "_j_msgid": 154604475 + } -点击通知进入应用程序时会触发该事件 +## 获取通知内容 -#####代码示例 +### event - jpush.receiveNotification + +点击通知进入应用程序时会触发该事件。 + +#### 代码示例 - 在你需要接收通知的的 js 文件中加入: - document.addEventListener("jpush.receiveNotification", onReceiveNotification, false); + document.addEventListener("jpush.receiveNotification", onReceiveNotification, false); - onReceiveNotification 需要这样写: + var alertContent; + if(device.platform == "Android") { + alertContent = window.plugins.jPushPlugin.receiveNotification.alert; + } else { + alertContent = event.aps.alert; + } + alert("open Notificaiton:" + alertContent); - var alertContent; - if(device.platform == "Android"){ - alertContent = window.plugins.jPushPlugin.receiveNotification.alert; - }else{ - alertContent = event.aps.alert; - } - alert("open Notificaiton:" + alertContent); +ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意。 -ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意 - -+ Android - - {"alert":"ding", - "extras":{ - "cn.jpush.android.MSG_ID":"1691785879", - "app":"com.thi.pushtest", - "cn.jpush.android.ALERT":"ding", - "cn.jpush.android.EXTRA":{}, - "cn.jpush.android.PUSH_ID":"1691785879", - "cn.jpush.android.NOTIFICATION_ID":1691785879, - "cn.jpush.android.NOTIFICATION_TYPE":"0"}} - -+ iOS ++ Android: { - "aps":{ - "badge":1, - "sound":"default", - "alert":"今天去哪儿" - }, - "key1":"value1", - "key2":"value2", - "_j_msgid":154604475 + "title": "title", + "alert":"ding", + "extras":{ + "yourKey": "yourValue", + "cn.jpush.android.MSG_ID":"1691785879", + "app":"com.thi.pushtest", + "cn.jpush.android.ALERT":"ding", + "cn.jpush.android.EXTRA":{}, + "cn.jpush.android.PUSH_ID":"1691785879", + "cn.jpush.android.NOTIFICATION_ID":1691785879, + "cn.jpush.android.NOTIFICATION_TYPE":"0" + } + } + ++ iOS: + + { + "aps":{ + "badge":1, + "sound":"default", + "alert":"今天去哪儿" + }, + "key1":"value1", + "key2":"value2", + "_j_msgid":154604475 } -### 获取自定义消息推送内容 +## 获取自定义消息推送内容 +### event - jpush.receiveMessage -####event - jpush.receiveMessage +收到应用内消息时触发这个事件,推荐使用事件的方式传递,但同时保留了 receiveMessageIniOSCallback 的回调函数,兼容以前的代码。 -收到应用内消息时触发这个事件 - -`推荐使用事件的方式传递,但同时保留了 receiveMessageIniOSCallback 的回调函数,兼容以前的代码` - - -#####代码示例 +#### 代码示例 - 在你需要接收通知的的 js 文件中加入: @@ -335,40 +334,39 @@ ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r - onReceiveMessage 需要这样写: + var onReceiveMessage = function(event) { + try{ + var message + if(device.platform == "Android") { + message = window.plugins.jPushPlugin.receiveMessage.message; + } else { + message = event.content; + } + $("#messageResult").html(message); - var onReceiveMessage = function(event) { - try{ - var message - if(device.platform == "Android") { - message = window.plugins.jPushPlugin.receiveMessage.message; - } else { - message = event.content; - } - $("#messageResult").html(message); - - } - catch(exception) { - console.log("JPushPlugin:onReceiveMessage-->" + exception); - } + } catch(exception) { + console.log("JPushPlugin:onReceiveMessage-->" + exception); } + } -ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveMessage,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意 +ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveMessage, +直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意。 -+ Android ++ Android: - {"message":"今天去哪儿", - "extras"{ + { + "message":"今天去哪儿", + "extras"{ + "yourKey": "yourValue", "cn.jpush.android.MSG_ID":"154378013", "cn.jpush.android.CONTENT_TYPE":"", "cn.jpush.android.EXTRA":{"key":"不添没有"} - } + } } -+ iOS - { - "content":"今天去哪儿", - "extras": - { - "key":"不填写没有" - } - } ++ iOS: + + { + "content":"今天去哪儿", + "extras":{"key":"不填写没有"} + } diff --git a/README.md b/README.md index 3375bb4..8ad898c 100644 --- a/README.md +++ b/README.md @@ -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) [![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) [![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 -2. 添加平台 +2. 添加平台: cd Myproj cordova platform add android cordova platform add ios - ps:这里请注意iOS平台,必须先执行 `cordova platform add ios`, - 然后再执行 `cordova plugin add xxxxx` 命令,不然有一些必须要的链接库需要手动添加 + ps: 这里请注意iOS平台,必须先执行 cordova platform add ios, + 然后再执行 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 -直接通过 url 安装 +直接通过 url 安装: 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 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 -3). 在 js 中调用函数,初始化 JPush SDK +#### 3.在 js 中调用函数,初始化 JPush //由于 PhoneGap 插件采用了 Lazy load 的特性,所以建议在 js 文件能执行的最开始就添加 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) - - -### 示例 - -"$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' 云服务进行打包,建议使用本地环境进行打包 +该项目基于 cordova 实现,目前无法使用 PhoneGap build 云服务进行打包,建议使用本地环境进行打包。 ## API 说明 -插件的 API 集中在 JPushPlugin.js 文件中,该文件的具体位置如下: +插件的 API 集中在 JPushPlugin.js 文件中,该文件的具体位置如下: Android: @@ -112,29 +104,35 @@ iOS: - [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 中右键单击工程名,Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add +eclipse 中 import PhoneGap 工程之后出现:`Type CallbackContext cannot be resolved to a type`。 -#### 2. iOS +解决方案:eclipse 中右键单击工程名,Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add。 -- 设置 / 修改 APP_KEY +### 2. iOS + +- 设置 / 修改 APP_KEY: 在 PushConfig.plist 中修改。 - PushConfig.plist 其他值说明: - CHANNEL: 渠道标识 - IsProduction: 是否生产环境(暂未启用) + PushConfig.plist 中其他值说明: -- 收不到推送 + - 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/) + + 如有问题可访问[极光社区](http://community.jpush.cn/) From d1e4f701883c05b16538ada5dfe9aeaba3691aed Mon Sep 17 00:00:00 2001 From: Hevin <328066446@qq.com> Date: Fri, 22 Apr 2016 13:16:17 +0800 Subject: [PATCH 3/3] =?UTF-8?q?=E5=AF=B9=E6=9F=90=E4=BA=9B=E6=96=B9?= =?UTF-8?q?=E6=B3=95=E6=B7=BB=E5=8A=A0=E6=9B=B4=E5=8A=A0=E8=AF=A6=E7=BB=86?= =?UTF-8?q?=E7=9A=84=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit eg.setBasicPushNotificationBuilder, setCustomPushNotificationBuilder --- API/Android_detail_api.md | 16 ++++++++++------ API/Common_detail_api.md | 36 ++++++++++++++++++------------------ 2 files changed, 28 insertions(+), 24 deletions(-) diff --git a/API/Android_detail_api.md b/API/Android_detail_api.md index e2fe475..ddfa7fe 100644 --- a/API/Android_detail_api.md +++ b/API/Android_detail_api.md @@ -36,7 +36,7 @@ - 内容: window.plugins.jPushPlugin.receiveMessage.message -- 附加字段: +- 附加字段: window.plugins.jPushPlugin.receiveMessage.extras.yourKey ## 获取集成日志 @@ -199,14 +199,18 @@ ### API - setBasicPushNotificationBuilder, setCustomPushNotificationBuilder 当用户需要定制默认的通知栏样式时,则可调用此方法。 +需要用户去自定义 ../JPushPlugin.java 中的同名方法代码,然后再在 js 端 调用该方法。 + +具体用法可参考[官方文档](http://docs.jpush.io/client/android_tutorials/#_11)。 + JPush SDK 提供了 2 个用于定制通知栏样式的构建类: -- setBasicPushNotificationBuilder - - Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)。 -- setCustomPushNotificationBuilder - - 继承 Basic 进一步让开发者定制 Notification Layout。 +- setBasicPushNotificationBuilder: + Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)。 +- setCustomPushNotificationBuilder: + 继承 Basic 进一步让开发者定制 Notification Layout。 -如果不调用此方法定制,则极光 Push SDK 默认的通知栏样式是:Android 标准的通知栏提示。 +如果不调用此方法定制,则极光 Push SDK 默认的通知栏样式是 Android 标准的通知栏。 #### 接口定义 diff --git a/API/Common_detail_api.md b/API/Common_detail_api.md index 1c10148..f9e997f 100644 --- a/API/Common_detail_api.md +++ b/API/Common_detail_api.md @@ -2,7 +2,7 @@ - [停止与恢复推送服务](#停止与恢复推送服务) - [获取 RegistrationID](#获取-registrationid) -- [别名与标签 API](#别名与标签-api) +- [设置别名与标签](#设置别名与标签) - [获取点击通知内容](#获取点击通知内容) - [获取通知内容](#获取通知内容) - [获取自定义消息推送内容](#获取自定义消息推送内容) @@ -11,12 +11,11 @@ ## 停止与恢复推送服务 ### API - init -调用此 API,用来开启 -JPush SDK 提供的推送服务。 +调用此 API,用来开启 JPush SDK 提供的推送服务。 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时,则必须要调用恢复推送服务 API。 -本功能是一个完全本地的状态操作。也就是说:停止推送服务的状态不会保存到服务器上。 +本功能是一个完全本地的状态操作,也就是说:停止推送服务的状态不会保存到服务器上。 如果停止推送服务后,开发者 App 被重新安装,或者被清除数据, JPush SDK 会恢复正常的默认行为。(因为保存在本地的状态数据被清除掉了)。 @@ -127,7 +126,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 } } -## 别名与标签 API +## 设置别名与标签 ### API - setTagsWithAlias, setTags, setAlias @@ -205,8 +204,8 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。 |6003|alias 字符串不合法。 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| |6004|alias超长。 |最多 40个字节,中文 UTF-8 是 3 个字节。| |6005|某一个 tag 字符串不合法。 |有效的别名、标签组成:字母(区分大小写)、数字、下划线、汉字。| -|6006|某一个 tag 超长。 |一个 tag 最多 40个字节 中文 UTF-8 是 3 个字节。| -|6007|tags 数量超出限制,最多 100 个。 |这是一台设备的限制。一个应用全局的标签数量无限制。| +|6006|某一个 tag 超长。 |一个 tag 最多 40个字节,中文 UTF-8 是 3 个字节。| +|6007|tags 数量超出限制,最多 100 个。 |这是一台设备的限制,一个应用全局的标签数量无限制。| |6008|tag / alias 超出总长度限制。 |总长度最多 1K 字节。| |6011|10s内设置 tag 或 alias 大于 3 次。 |短时间内操作过于频繁。| @@ -269,23 +268,23 @@ ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.o ### event - jpush.receiveNotification -点击通知进入应用程序时会触发该事件。 +收到通知时会触发该事件。 #### 代码示例 - 在你需要接收通知的的 js 文件中加入: - document.addEventListener("jpush.receiveNotification", onReceiveNotification, false); + document.addEventListener("jpush.receiveNotification", onReceiveNotification, false); - onReceiveNotification 需要这样写: - var alertContent; - if(device.platform == "Android") { - alertContent = window.plugins.jPushPlugin.receiveNotification.alert; - } else { - alertContent = event.aps.alert; - } - alert("open Notificaiton:" + alertContent); + var alertContent; + if(device.platform == "Android") { + alertContent = window.plugins.jPushPlugin.receiveNotification.alert; + } else { + alertContent = event.aps.alert; + } + alert("open Notificaiton:" + alertContent); ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification,直接访问即可,字段示例,根据实际推送情况,可能略有差别,请注意。 @@ -324,7 +323,9 @@ ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r ### event - jpush.receiveMessage -收到应用内消息时触发这个事件,推荐使用事件的方式传递,但同时保留了 receiveMessageIniOSCallback 的回调函数,兼容以前的代码。 +收到自定义消息时触发这个事件,推荐使用事件的方式传递。 + +但同时保留了 receiveMessageIniOSCallback 的回调函数,兼容以前的代码。 #### 代码示例 @@ -343,7 +344,6 @@ ps:点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.r message = event.content; } $("#messageResult").html(message); - } catch(exception) { console.log("JPushPlugin:onReceiveMessage-->" + exception); }