mirror of
https://github.com/jpush/jpush-phonegap-plugin.git
synced 2026-05-08 00:02:05 +08:00
iOS - update
1.更新目录 2.更新 README.md 3.重写 iOS_install.md
This commit is contained in:
E.B
@@ -0,0 +1,263 @@
|
||||
# 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.receiveMessage.message
|
||||
- 附加字段:
|
||||
window.plugins.jPushPlugin.receiveMessage.extras.yourKey
|
||||
|
||||
## 获取集成日志
|
||||
|
||||
### API - setDebugMode
|
||||
|
||||
用于开启调试模式，可以查看集成 JPush 过程中的 Log，如果集成失败，可方便定位问题所在。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setDebugMode(mode)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- mode:
|
||||
- true 显示集成日志。
|
||||
- false 不显示集成日志。
|
||||
|
||||
|
||||
## 接收消息和点击通知事件
|
||||
### API - receiveMessageInAndroidCallback
|
||||
|
||||
用于 Android 收到应用内消息的回调函数(请注意和通知的区别)，该函数不需要主动调用。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.receiveMessageInAndroidCallback(data)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- data: 接收到的 js 字符串，包含的 key:value 请进入该函数体查看。
|
||||
|
||||
|
||||
### API - openNotificationInAndroidCallback
|
||||
|
||||
当点击 Android 手机的通知栏进入应用程序时，会调用这个函数，这个函数不需要主动调用，是作为回调函数来用的。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.openNotificationInAndroidCallback(data)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- data: js 字符串。
|
||||
|
||||
|
||||
## 统计分析
|
||||
|
||||
### API - onResume / onPause
|
||||
|
||||
这是一个 Android Local API，不是 js 的 API，请注意。
|
||||
本 API 用于“用户使用时长”，“活跃用户”，“用户打开次数”的统计，并上报到服务器，在 Portal 上展示给开发者。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
public static void onResume(final Activity activity)
|
||||
public static void onPause(final Activity activity)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- Activity: 当前所在的 Activity。
|
||||
|
||||
#### 调用说明
|
||||
|
||||
应在所有的 Activity 的 onResume / onPause 方法里调用。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
@Override
|
||||
protected void onResume() {
|
||||
super.onResume();
|
||||
JPushInterface.onResume(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void onPause() {
|
||||
super.onPause();
|
||||
JPushInterface.onPause(this);
|
||||
}
|
||||
|
||||
### API - setStatisticsOpen
|
||||
|
||||
用于在 js 中控制是否打开应用的统计分析功能，但如果已经添加了上面的 onResume / onPause 方法，
|
||||
就不能再通过这个方法来控制统计分析功能了。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setStatisticsOpen(boolean)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- boolean:
|
||||
- true: 打开统计分析功能。
|
||||
- false: 关闭统计分析功能。
|
||||
|
||||
### API - reportNotificationOpened
|
||||
|
||||
用于上报用户的通知栏被打开，或者用于上报用户自定义消息被展示等客户端需要统计的事件。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.reportNotificationOpened(msgID)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- msgID: 收到的通知或者自定义消息的 id。
|
||||
|
||||
|
||||
## 清除通知
|
||||
|
||||
### API - clearAllNotification
|
||||
|
||||
推送通知到客户端时，由 JPush SDK 展现通知到通知栏上。
|
||||
|
||||
此 API 提供清除通知的功能，包括：清除所有 JPush 展现的通知（不包括非 JPush SDK 展现的）。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.clearAllNotification()
|
||||
|
||||
|
||||
## 设置允许推送时间
|
||||
|
||||
### API - setPushTime
|
||||
默认情况下用户在任何时间都允许推送。即任何时候有推送下来，客户端都会收到，并展示。
|
||||
开发者可以调用此 API 来设置允许推送的时间。
|
||||
如果不在该时间段内收到消息，当前的行为是：推送到的通知会被扔掉。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setPushTime(days, startHour, endHour)
|
||||
|
||||
#### 参数说明
|
||||
- days: 数组，0 表示星期天，1 表示星期一，以此类推（7天制，数组中值的范围为 0 到 6 ）。
|
||||
数组的值为 null, 表示任何时间都可以收到消息和通知，数组的 size 为 0，则表示任何时间都收不到消息和通知。
|
||||
- startHour: 整形，允许推送的开始时间 （24 小时制：startHour 的范围为 0 到 23）。
|
||||
- endHour: 整形，允许推送的结束时间 （24 小时制：endHour 的范围为 0 到 23）。
|
||||
|
||||
## 设置通知静默时间
|
||||
|
||||
### API - setSilenceTime
|
||||
默认情况下用户在收到推送通知时，客户端可能会有震动，响铃等提示。
|
||||
但用户在睡觉、开会等时间点希望为 "免打扰" 模式，也是静音时段的概念。
|
||||
开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息，则：不会有铃声和震动。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setSilenceTime(startHour, startMinute, endHour, endMinute)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- startHour: 整形，静音时段的开始时间 - 小时 （24小时制，范围：0~23 ）。
|
||||
- startMinute: 整形，静音时段的开始时间 - 分钟（范围：0~59 ）。
|
||||
- endHour: 整形，静音时段的结束时间 - 小时 （24小时制，范围：0~23 ）。
|
||||
- endMinute: 整形，静音时段的结束时间 - 分钟（范围：0~59 ）。
|
||||
|
||||
|
||||
## 通知栏样式定制
|
||||
|
||||
### 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。
|
||||
|
||||
如果不调用此方法定制，则极光 Push SDK 默认的通知栏样式是 Android 标准的通知栏。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setBasicPushNotificationBuilder()
|
||||
window.plugins.jPushPlugin.setCustomPushNotificationBuilder()
|
||||
|
||||
|
||||
## 设置保留最近通知条数
|
||||
|
||||
### API - setLatestNotificationNum
|
||||
|
||||
通过极光推送，推送了很多通知到客户端时，如果用户不去处理，就会有很多保留在那里。
|
||||
|
||||
默认为保留最近 5 条通知，开发者可通过调用此 API 来定义为不同的数量。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setLatestNotificationNum(num)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- num: 保存的条数。
|
||||
|
||||
|
||||
## 本地通知
|
||||
### API - addLocalNotification, removeLocalNotification, clearLocalNotifications
|
||||
|
||||
本地通知 API 不依赖于网络，无网条件下依旧可以触发。
|
||||
|
||||
本地通知与网络推送的通知是相互独立的，不受保留最近通知条数上限的限制。
|
||||
|
||||
本地通知的定时时间是自发送时算起的，不受中间关机等操作的影响。
|
||||
|
||||
三个接口的功能分别为：添加一个本地通知，删除一个本地通知，删除所有的本地通知。
|
||||
|
||||
#####接口定义
|
||||
|
||||
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 字符串。
|
||||
@@ -0,0 +1,135 @@
|
||||
#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. 复制：$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 节点下添加以下权限
|
||||
|
||||
<!-- Required 一些系统要求的权限，如访问网络等-->
|
||||
<uses-permission android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"/>
|
||||
<uses-permission android:name="android.permission.RECEIVE_USER_PRESENT"/>
|
||||
<uses-permission android:name="android.permission.INTERNET"/>
|
||||
<uses-permission android:name="android.permission.WAKE_LOCK"/>
|
||||
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
|
||||
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
|
||||
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
|
||||
<uses-permission android:name="android.permission.VIBRATE"/>
|
||||
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
|
||||
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
|
||||
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
|
||||
<permission
|
||||
android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"
|
||||
android:protectionLevel="signature"/>
|
||||
|
||||
7. 修改 AndroidManifest.xml 在 manifest/application 节点下添加SDK相关组件声明
|
||||
|
||||
<activity
|
||||
android:name="cn.jpush.android.ui.PushActivity"
|
||||
android:theme="@android:style/Theme.Translucent.NoTitleBar"
|
||||
android:configChanges="orientation|keyboardHidden">
|
||||
<intent-filter>
|
||||
<action android:name="cn.jpush.android.ui.PushActivity"/>
|
||||
|
||||
<category android:name="android.intent.category.DEFAULT"/>
|
||||
<category android:name="$PACKAGE_NAME"/>
|
||||
</intent-filter>
|
||||
</activity>
|
||||
|
||||
<!-- Required SDK 核心功能-->
|
||||
<service
|
||||
android:name="cn.jpush.android.service.DownloadService"
|
||||
android:enabled="true"
|
||||
android:exported="false">
|
||||
</service>
|
||||
|
||||
<!-- Required SDK 核心功能-->
|
||||
<service
|
||||
android:name="cn.jpush.android.service.PushService"
|
||||
android:enabled="true"
|
||||
android:exported="false">
|
||||
<intent-filter>
|
||||
<action android:name="cn.jpush.android.intent.REGISTER"/>
|
||||
<action android:name="cn.jpush.android.intent.REPORT"/>
|
||||
<action android:name="cn.jpush.android.intent.PushService"/>
|
||||
<action android:name="cn.jpush.android.intent.PUSH_TIME"/>
|
||||
</intent-filter>
|
||||
</service>
|
||||
|
||||
<!-- Required SDK 核心功能-->
|
||||
<receiver
|
||||
android:name="cn.jpush.android.service.PushReceiver"
|
||||
android:enabled="true">
|
||||
<intent-filter android:priority="1000">
|
||||
<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY"/>
|
||||
|
||||
<!--Required 显示通知栏 -->
|
||||
<category android:name="$PACKAGE_NAME"/>
|
||||
</intent-filter>
|
||||
|
||||
<intent-filter>
|
||||
<action android:name="android.intent.action.USER_PRESENT"/>
|
||||
<action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
|
||||
</intent-filter>
|
||||
|
||||
<!-- Optional -->
|
||||
<intent-filter>
|
||||
<action android:name="android.intent.action.PACKAGE_ADDED"/>
|
||||
<action android:name="android.intent.action.PACKAGE_REMOVED"/>
|
||||
<data android:scheme="package"/>
|
||||
</intent-filter>
|
||||
</receiver>
|
||||
|
||||
<!-- User defined. For test only 用户自定义的广播接收器 -->
|
||||
<receiver
|
||||
android:name="cn.jpush.phonegap.MyReceiver"
|
||||
android:enabled="true">
|
||||
<intent-filter android:priority="1000">
|
||||
<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY"/>
|
||||
|
||||
<!-- Required 显示通知栏 -->
|
||||
<category android:name="$PACKAGE_NAME"/>
|
||||
</intent-filter>
|
||||
|
||||
<intent-filter>
|
||||
<action android:name="cn.jpush.android.intent.REGISTRATION"/>
|
||||
|
||||
<!-- Required 用户注册 SDK 的intent -->
|
||||
<action android:name="cn.jpush.android.intent.UNREGISTRATION"/>
|
||||
<action android:name="cn.jpush.android.intent.MESSAGE_RECEIVED"/>
|
||||
|
||||
<!-- Required 用户接收 SDK 消息的intent -->
|
||||
<action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED"/>
|
||||
|
||||
<!-- Required 用户接收 SDK 通知栏信息的intent -->
|
||||
<action android:name="cn.jpush.android.intent.NOTIFICATION_OPENED"/>
|
||||
|
||||
<!-- Required 用户打开自定义通知栏的intent -->
|
||||
<action android:name="cn.jpush.android.intent.ACTION_RICHPUSH_CALLBACK"/>
|
||||
|
||||
<!-- Optional 用户接受 Rich Push Javascript 回调函数的intent -->
|
||||
<category android:name="$PACKAGE_NAME"/>
|
||||
</intent-filter>
|
||||
</receiver>
|
||||
|
||||
<!-- Required SDK核心功能-->
|
||||
<receiver
|
||||
android:name="cn.jpush.android.service.AlarmReceiver"/>
|
||||
|
||||
<!-- Required. Enable it you can get statistics data with channel -->
|
||||
<meta-data
|
||||
android:name="JPUSH_CHANNEL" android:value="developer-default"/>
|
||||
|
||||
<meta-data
|
||||
android:name="JPUSH_APPKEY" android:value="299d0fee887820e7d90a68b2"/>
|
||||
@@ -0,0 +1,372 @@
|
||||
# 通用 API 说明
|
||||
|
||||
- [停止与恢复推送服务](#停止与恢复推送服务)
|
||||
- [获取 RegistrationID](#获取-registrationid)
|
||||
- [设置别名与标签](#设置别名与标签)
|
||||
- [获取点击通知内容](#获取点击通知内容)
|
||||
- [获取通知内容](#获取通知内容)
|
||||
- [获取自定义消息推送内容](#获取自定义消息推送内容)
|
||||
|
||||
|
||||
## 停止与恢复推送服务
|
||||
### API - init
|
||||
|
||||
调用此 API，用来开启 JPush SDK 提供的推送服务。
|
||||
|
||||
开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务。当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
|
||||
|
||||
本功能是一个完全本地的状态操作，也就是说：停止推送服务的状态不会保存到服务器上。
|
||||
|
||||
如果停止推送服务后，开发者 App 被重新安装，或者被清除数据，
|
||||
JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。
|
||||
|
||||
本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息，
|
||||
恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.init()
|
||||
|
||||
### API - stopPush
|
||||
+ Android 平台:
|
||||
|
||||
+ 开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务，当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
|
||||
|
||||
+ 调用了本 API 后，JPush 推送服务完全被停止，具体表现为：
|
||||
|
||||
+ JPush Service 不在后台运行。
|
||||
+ 收不到推送消息。
|
||||
+ 不能通过 JPushInterface.init 恢复，需要调用 resumePush 恢复。
|
||||
+ 极光推送所有的其他 API 调用都无效。
|
||||
|
||||
+ iOS 平台:
|
||||
|
||||
+ 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化。
|
||||
+ 推荐：设置一个 UI 界面， 提醒用户在 设置－通知 中关闭推送服务。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.stopPush()
|
||||
|
||||
|
||||
### API - resumePush
|
||||
|
||||
恢复推送服务。调用了此 API 后:
|
||||
|
||||
+ Android 平台:
|
||||
|
||||
+ 极光推送完全恢复正常工作。
|
||||
|
||||
+ iOS 平台:
|
||||
|
||||
+ 重新去APNS注册。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.resumePush()
|
||||
|
||||
### API - isPushStopped
|
||||
|
||||
+ Android 平台:
|
||||
|
||||
+ 用来检查 Push Service 是否已经被停止。
|
||||
|
||||
+ iOS 平台:
|
||||
|
||||
+ 平台检查推送服务是否注册。
|
||||
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.isPushStopped(callback)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
+ callback: 回调函数，用来通知 JPush 的推送服务是否开启。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.resumePush(callback)
|
||||
var onCallback = function(data) {
|
||||
if(data > 0) {
|
||||
// 开启
|
||||
} else {
|
||||
// 关闭
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
## 获取 RegistrationID
|
||||
|
||||
### API - getRegistrationID
|
||||
|
||||
RegistrationID 定义:
|
||||
|
||||
集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时，JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。
|
||||
JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
|
||||
|
||||
应用程序可以把此 RegistrationID 保存以自己的应用服务器上，然后就可以根据 RegistrationID 来向设备推送消息或者通知。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
JPushPlugin.prototype.getRegistrationID(callback)
|
||||
|
||||
#### 返回值
|
||||
|
||||
调用此 API 来取得应用程序对应的 RegistrationID。 只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID);
|
||||
var onGetRegistradionID = function(data) {
|
||||
try {
|
||||
console.log("JPushPlugin:registrationID is " + data);
|
||||
} catch(exception) {
|
||||
console.log(exception);
|
||||
}
|
||||
}
|
||||
|
||||
## 设置别名与标签
|
||||
|
||||
### API - setTagsWithAlias, setTags, setAlias
|
||||
|
||||
提供几个相关 API 用来设置别名（alias）与标签（tags）。
|
||||
|
||||
这几个 API 可以在 App 里任何地方调用。
|
||||
|
||||
**别名 Alias**:
|
||||
|
||||
为安装了应用程序的用户，取个别名来标识。以后给该用户 Push 消息时，就可以用此别名来指定。
|
||||
|
||||
每个用户只能指定一个别名。
|
||||
|
||||
同一个应用程序内，对不同的用户，建议取不同的别名。这样，尽可能根据别名来唯一确定用户。
|
||||
|
||||
系统不限定一个别名只能指定一个用户。如果一个别名被指定到了多个用户，当给指定这个别名发消息时，服务器端 API 会同时给这多个用户发送消息。
|
||||
|
||||
举例：在一个用户要登录的游戏中，可能设置别名为 userid。游戏运营时，发现该用户 3 天没有玩游戏了，则根据 userid 调用服务器端 API 发通知到客户端提醒用户。
|
||||
|
||||
**标签 Tag**:
|
||||
|
||||
为安装了应用程序的用户，打上标签。其目的主要是方便开发者根据标签，来批量下发 Push 消息。
|
||||
|
||||
可为每个用户打多个标签。
|
||||
|
||||
不同应用程序、不同的用户，可以打同样的标签。
|
||||
|
||||
举例： game, old_page, women。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
JPushPlugin.prototype.setTagsWithAlias(tags, alias)
|
||||
JPushPlugin.prototype.setTags(tags)
|
||||
JPushPlugin.prototype.setAlias(alias)
|
||||
|
||||
#### 参数说明
|
||||
* tags:
|
||||
* 参数类型为数组。
|
||||
* nil 此次调用不设置此值。
|
||||
* 空集合表示取消之前的设置。
|
||||
* 每次调用至少设置一个 tag，覆盖之前的设置，不是新增。
|
||||
* 有效的标签组成：字母（区分大小写）、数字、下划线、汉字。
|
||||
* 限制：每个 tag 命名长度限制为 40 字节，最多支持设置 100 个 tag，但总长度不得超过1K字节（判断长度需采用 UTF-8 编码）。
|
||||
* 单个设备最多支持设置 100 个 tag，App 全局 tag 数量无限制。
|
||||
* alias:
|
||||
* 参数类型为字符串。
|
||||
* nil 此次调用不设置此值。
|
||||
* 空字符串 （""）表示取消之前的设置。
|
||||
* 有效的别名组成：字母（区分大小写）、数字、下划线、汉字。
|
||||
* 限制：alias 命名长度限制为 40 字节（判断长度需采用 UTF-8 编码）。
|
||||
|
||||
#### 返回值说明
|
||||
|
||||
函数本身无返回值，但需要注册 `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);
|
||||
}
|
||||
}
|
||||
|
||||
#### 错误码定义
|
||||
|
||||
|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 次。 |短时间内操作过于频繁。|
|
||||
|
||||
|
||||
## 获取点击通知内容
|
||||
|
||||
### event - jpush.openNotification
|
||||
|
||||
点击通知进入应用程序时会出发改事件。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.openNotification", onOpenNotification, false);
|
||||
|
||||
- onOpenNotification 需要这样写：
|
||||
|
||||
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，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
|
||||
|
||||
+ Android:
|
||||
|
||||
{
|
||||
"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.receiveNotification
|
||||
|
||||
收到通知时会触发该事件。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
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);
|
||||
|
||||
ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification，直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
|
||||
|
||||
+ Android:
|
||||
|
||||
{
|
||||
"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
|
||||
|
||||
收到自定义消息时触发这个事件，推荐使用事件的方式传递。
|
||||
|
||||
但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.receiveMessage", onReceiveMessage, false);
|
||||
|
||||
- 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);
|
||||
} catch(exception) {
|
||||
console.log("JPushPlugin:onReceiveMessage-->" + exception);
|
||||
}
|
||||
}
|
||||
|
||||
ps：点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveMessage，
|
||||
直接访问即可，字段示例，根据实际推送情况，可能略有差别，请注意。
|
||||
|
||||
+ Android:
|
||||
|
||||
{
|
||||
"message":"今天去哪儿",
|
||||
"extras"{
|
||||
"yourKey": "yourValue",
|
||||
"cn.jpush.android.MSG_ID":"154378013",
|
||||
"cn.jpush.android.CONTENT_TYPE":"",
|
||||
"cn.jpush.android.EXTRA":{"key":"不添没有"}
|
||||
}
|
||||
}
|
||||
|
||||
+ iOS：
|
||||
|
||||
{
|
||||
"content":"今天去哪儿",
|
||||
"extras":{"key":"不填写没有"}
|
||||
}
|
||||
+571
@@ -0,0 +1,571 @@
|
||||
# iOS API
|
||||
|
||||
- [开始与停止推送服务](#开始与停止推送服务)
|
||||
- [获取 RegistrationID](#获取-registrationid)
|
||||
- [别名与标签](#别名与标签)
|
||||
- [获取 APNS 推送内容](#获取-apns-推送内容)
|
||||
- [点击推送通知](#点击推送通知)
|
||||
- [前台收到推送](#前台收到推送)
|
||||
- [后台收到推送](#后台收到推送)
|
||||
- [获取自定义消息内容](#获取自定义消息内容)
|
||||
- [设置Badge](#设置badge)
|
||||
- [本地通知](#本地通知)
|
||||
- [页面的统计](#页面的统计)
|
||||
- [日志等级设置](#日志等级设置)
|
||||
- [地理位置上报](#地理位置上报)
|
||||
- [设备平台判断](#设备平台判断)
|
||||
|
||||
## 开始与停止推送服务
|
||||
|
||||
### API - init
|
||||
|
||||
调用此 API,用来开启 JPush SDK 提供的推送服务。
|
||||
|
||||
开发者 App 可以通过调用停止推送服务 API 来停止极光推送服务，当又需要使用极光推送服务时，则必须要调用恢复推送服务 API。
|
||||
|
||||
```
|
||||
本功能是一个完全本地的状态操作。也就是说：停止推送服务的状态不会保存到服务器上。
|
||||
如果停止推送服务后，开发者 App 被重新安装，或者被清除数据，
|
||||
JPush SDK 会恢复正常的默认行为。（因为保存在本地的状态数据被清除掉了）。
|
||||
本功能其行为类似于网络中断的效果，即：推送服务停止期间推送的消息，
|
||||
恢复推送服务后，如果推送的消息还在保留的时长范围内，则客户端是会收到离线消息。
|
||||
```
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.init()
|
||||
|
||||
|
||||
### API - stopPush
|
||||
|
||||
- 不推荐调用，因为这个 API 只是让你的 DeviceToken 失效，在 设置－通知 中您的应用程序没有任何变化。
|
||||
- 推荐：设置一个 UI 界面，提醒用户在 设置－通知 中关闭推送服务。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.stopPush()
|
||||
|
||||
|
||||
### API - resumePush
|
||||
|
||||
恢复推送服务。调用了此 API 后，iOS平台，重新去APNS注册。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.resumePush()
|
||||
|
||||
|
||||
### API - isPushStopped
|
||||
|
||||
iOS平台，检查推送服务是否注册。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.isPushStopped(callback)
|
||||
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- callback 回调函数，用来通知 JPush 的推送服务是否开启。
|
||||
|
||||
#### 代码示例
|
||||
window.plugins.jPushPlugin.resumePush(callback)
|
||||
var onCallback = function(data) {
|
||||
if(data > 0) {
|
||||
// 开启
|
||||
} else {
|
||||
// 关闭
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
## 获取 RegistrationID
|
||||
|
||||
### API - getRegistrationID
|
||||
|
||||
RegistrationID 定义:
|
||||
|
||||
集成了 JPush SDK 的应用程序在第一次成功注册到 JPush 服务器时，JPush 服务器会给客户端返回一个唯一的该设备的标识 - RegistrationID。
|
||||
JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
|
||||
|
||||
应用程序可以把此 RegistrationID 保存以自己的应用服务器上，然后就可以根据 RegistrationID 来向设备推送消息或者通知。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
JPushPlugin.prototype.getRegistrationID(callback)
|
||||
|
||||
#### 返回值
|
||||
|
||||
调用此 API 来取得应用程序对应的 RegistrationID。只有当应用程序成功注册到 JPush 的服务器时才返回对应的值，否则返回空字符串。
|
||||
|
||||
#### 调用示例
|
||||
|
||||
window.plugins.jPushPlugin.getRegistrationID(onGetRegistradionID);
|
||||
var onGetRegistradionID = function(data) {
|
||||
try {
|
||||
console.log("JPushPlugin:registrationID is " + data);
|
||||
} catch(exception) {
|
||||
console.log(exception);
|
||||
}
|
||||
}
|
||||
|
||||
## 别名与标签
|
||||
|
||||
### API - setTagsWithAlias, setTags, setAlias
|
||||
|
||||
提供几个相关 API 用来设置别名（alias）与标签（tags）。
|
||||
|
||||
这几个 API 可以在 App 里任何地方调用。
|
||||
|
||||
**别名 Alias**
|
||||
|
||||
为安装了应用程序的用户，取个别名来标识。以后给该用户 Push 消息时，就可以用此别名来指定。
|
||||
|
||||
每个用户只能指定一个别名。
|
||||
|
||||
同一个应用程序内，对不同的用户，建议取不同的别名。这样，尽可能根据别名来唯一确定用户。
|
||||
|
||||
系统不限定一个别名只能指定一个用户。如果一个别名被指定到了多个用户，当给指定这个别名发消息时，服务器端 API 会同时给这多个用户发送消息。
|
||||
|
||||
举例：在一个用户要登录的游戏中，可能设置别名为 userid。游戏运营时，发现该用户 3 天没有玩游戏了，则根据 userid 调用服务器端 API 发通知到客户端提醒用户。
|
||||
|
||||
**标签 Tag**
|
||||
|
||||
为安装了应用程序的用户，打上标签。其目的主要是方便开发者根据标签，来批量下发 Push 消息。
|
||||
|
||||
可为每个用户打多个标签。
|
||||
|
||||
不同应用程序、不同的用户，可以打同样的标签。
|
||||
|
||||
举例: game, old_page, women。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
JPushPlugin.prototype.setTagsWithAlias(tags, alias)
|
||||
JPushPlugin.prototype.setTags(tags)
|
||||
JPushPlugin.prototype.setAlias(alias)
|
||||
|
||||
#### 参数说明
|
||||
* tags:
|
||||
* 参数类型为数组。
|
||||
* nil 此次调用不设置此值。
|
||||
* 空集合表示取消之前的设置。
|
||||
* 每次调用至少设置一个 tag，覆盖之前的设置，不是新增。
|
||||
* 有效的标签组成：字母（区分大小写）、数字、下划线、汉字。
|
||||
* 限制：每个 tag 命名长度限制为 40 字节，最多支持设置 100 个 tag，但总长度不得超过1K字节（判断长度需采用UTF-8编码）。
|
||||
* 单个设备最多支持设置 100 个 tag，App 全局 tag 数量无限制。
|
||||
* alias:
|
||||
* 参数类型为字符串。
|
||||
* nil 此次调用不设置此值。
|
||||
* 空字符串 （""）表示取消之前的设置。
|
||||
* 有效的别名组成：字母（区分大小写）、数字、下划线、汉字。
|
||||
* 限制：alias 命名长度限制为 40 字节（判断长度需采用 UTF-8 编码）。
|
||||
|
||||
#### 返回值说明
|
||||
|
||||
函数本身无返回值，但需要注册 `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)
|
||||
}
|
||||
}
|
||||
|
||||
#### 错误码定义
|
||||
|
||||
|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次 |短时间内操作过于频繁。|
|
||||
|
||||
|
||||
## 获取 APNS 推送内容
|
||||
|
||||
### 点击推送通知
|
||||
|
||||
#### event - jpush.openNotification
|
||||
|
||||
点击通知启动或唤醒应用程序时会出发该事件
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.openNotification", onOpenNotification, false);
|
||||
|
||||
- onOpenNotification 需要这样写：
|
||||
|
||||
var onOpenNotification = function(event) {
|
||||
var alertContent;
|
||||
alertContent = event.aps.alert;
|
||||
alert("open Notificaiton:" + alertContent);
|
||||
}
|
||||
|
||||
- event 举例:
|
||||
|
||||
{
|
||||
"aps":{
|
||||
"badge":1,
|
||||
"sound":"default",
|
||||
"alert":"今天去哪儿"
|
||||
},
|
||||
"key1":"value1",
|
||||
"key2":"value2",
|
||||
"_j_msgid":154604475
|
||||
}
|
||||
|
||||
### 前台收到推送
|
||||
|
||||
#### event - jpush.receiveNotification
|
||||
|
||||
应用程序处于前台时收到推送会触发该事件
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.receiveNotification", onReceiveNotification, false);
|
||||
|
||||
- onReceiveNotification 需要这样写：
|
||||
|
||||
var onReceiveNotification = function(event) {
|
||||
var alertContent;
|
||||
alertContent = event.aps.alert;
|
||||
alert("open Notificaiton:" + alertContent);
|
||||
}
|
||||
|
||||
- event 举例
|
||||
|
||||
{
|
||||
"aps":{
|
||||
"badge":1,
|
||||
"sound":"default",
|
||||
"alert":"今天去哪儿"
|
||||
},
|
||||
"key1":"value1",
|
||||
"key2":"value2",
|
||||
"_j_msgid":154604475
|
||||
}
|
||||
|
||||
### 后台收到推送
|
||||
|
||||
#### event - jpush.backgroundNotification
|
||||
|
||||
应用程序处于后台时收到推送会触发该事件，可以在后台执行一段代码。具体配置参考 [iOS 7 Background Remote Notification](http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification)
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.backgroundNotification", onBackgroundNotification, false);
|
||||
|
||||
- onBackgroundNotification 需要这样写：
|
||||
|
||||
var onBackgroundNotification = function(event) {
|
||||
var alertContent;
|
||||
alertContent = event.aps.alert;
|
||||
alert("open Notificaiton:" + alertContent);
|
||||
}
|
||||
|
||||
+ event 举例
|
||||
|
||||
{
|
||||
"aps":{
|
||||
"badge":1,
|
||||
"sound":"default",
|
||||
"alert":"今天去哪儿"
|
||||
},
|
||||
"key1":"value1",
|
||||
"key2":"value2",
|
||||
"_j_msgid":154604475
|
||||
}
|
||||
|
||||
#### API - receiveMessageIniOSCallback
|
||||
|
||||
用于 iOS 收到应用内消息的回调函数(请注意和通知的区别)，该函数不需要主动调用
|
||||
不推荐使用回调函数
|
||||
|
||||
##### 接口定义
|
||||
|
||||
JPushPlugin.prototype.receiveMessageIniOSCallback(data)
|
||||
|
||||
##### 参数说明
|
||||
|
||||
- data: 是一个 js 字符串使用如下代码解析，js 具体 key 根据应用内消息来确定:
|
||||
|
||||
var bToObj = JSON.parse(data);
|
||||
|
||||
|
||||
## 获取自定义消息内容
|
||||
|
||||
|
||||
### event - jpush.receiveMessage
|
||||
|
||||
收到应用内消息时触发这个事件, 推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码。
|
||||
|
||||
|
||||
#### 代码示例
|
||||
|
||||
- 在你需要接收通知的的 js 文件中加入:
|
||||
|
||||
document.addEventListener("jpush.receiveMessage", onReceiveMessage, false);
|
||||
|
||||
- onReceiveMessage 需要这样写：
|
||||
|
||||
var onReceiveMessage = function(event) {
|
||||
try{
|
||||
var message;
|
||||
message = event.content;
|
||||
$("#messageResult").html(message);
|
||||
}catch(exception) {
|
||||
console.log("JPushPlugin:onReceiveMessage-->" + exception);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
- event 举例:
|
||||
|
||||
{
|
||||
"content":"今天去哪儿",
|
||||
"extras":
|
||||
{
|
||||
"key":"不填写没有"
|
||||
}
|
||||
}
|
||||
|
||||
## 设置Badge
|
||||
### API - setBadge, resetBadge
|
||||
|
||||
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 打印设置结果。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setBadge(5);
|
||||
window.plugins.jPushPlugin.reSetBadge();
|
||||
|
||||
### API - setApplicationIconBadgeNumber
|
||||
|
||||
本接口直接改变应用本地的角标值，设置 iOS 的角标，当设置 badge ＝ 0 时为清除角标。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setApplicationIconBadgeNumber(badge)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- badge: 整形，例如 0，1，2（当 badge 为 0 时，角标被清除）。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0);
|
||||
|
||||
### API - getApplicationIconBadgeNumber
|
||||
|
||||
获取 iOS 的角标值。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.getApplicationIconBadgeNumber(callback)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- callback: 回调函数。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data) {
|
||||
console.log(data);
|
||||
});
|
||||
|
||||
|
||||
## 本地通知
|
||||
|
||||
### API - addLocalNotificationForIOS
|
||||
|
||||
用于注册本地通知，最多支持64个。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.addLocalNotificationForIOS(delayTime, content, badge, notificationID, extras)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- delayTime: 本地推送延迟多长时间后显示，数值类型或纯数字的字符型均可。
|
||||
- content: 本地推送需要显示的内容。
|
||||
- badge: 角标的数字。如果不需要改变角标传-1。数值类型或纯数字的字符型均可。
|
||||
- notificationID: 本地推送标识符,字符串。
|
||||
- extras: 自定义参数，可以用来标识推送和增加附加信息。字典类型。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.addLocalNotificationForIOS(6*60*60, "本地推送内容", 1, "notiId", {"key":"value"});
|
||||
|
||||
### API - deleteLocalNotificationWithIdentifierKeyInIOS
|
||||
|
||||
删除本地推送定义。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.deleteLocalNotificationWithIdentifierKeyInIOS(identifierKey)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- identifierKey: 本地推送标识符。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS("identifier");
|
||||
|
||||
### API - clearAllLocalNotifications
|
||||
|
||||
清除所有本地推送对象。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.clearAllLocalNotifications()
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.clearAllLocalNotifications();
|
||||
|
||||
|
||||
## 页面的统计
|
||||
|
||||
### 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 来自定义加入页面和时间信息。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.beginLogPageView("newPage", 5);
|
||||
window.plugins.jPushPlugin.startLogPageView("onePage");
|
||||
window.plugins.jPushPlugin.stopLogPageView("onePage");
|
||||
|
||||
|
||||
## 日志等级设置
|
||||
|
||||
### API - setDebugModeFromIos
|
||||
|
||||
用于开启 Debug 模式，显示更多的日志信息。
|
||||
|
||||
建议调试时开启这个选项，不调试的时候注释这句代码，这个函数 setLogOFF 是相反的一对。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setDebugModeFromIos()
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setDebugModeFromIos();
|
||||
|
||||
### API - setLogOFF
|
||||
|
||||
用来关闭日志信息（除了必要的错误信息）。
|
||||
|
||||
不需要任何调试信息的时候，调用此 API（发布时建议调用此 API，用来屏蔽日志信息，节省性能消耗)。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setLogOFF()
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setLogOFF();
|
||||
|
||||
### API - setCrashLogON
|
||||
|
||||
用于统计用户应用崩溃日志。
|
||||
|
||||
如果需要统计 Log 信息，调用该接口。当你需要自己收集错误信息时，切记不要调用该接口。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setCrashLogON()
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setCrashLogON();
|
||||
|
||||
## 地理位置上报
|
||||
|
||||
### API - setLocation
|
||||
|
||||
用于统计用户地理信息。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setLocation(latitude, longitude)
|
||||
|
||||
#### 参数说明
|
||||
|
||||
- latitude: 地理位置纬度，数值类型或纯数字的字符型均可。
|
||||
- longitude: 地理位置精度，数值类型或纯数字的字符型均可。
|
||||
|
||||
#### 代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setLocation(39.26,115.25);
|
||||
|
||||
## 设备平台判断
|
||||
|
||||
### API - isPlatformIOS
|
||||
|
||||
用于区分 iOS, Android 平台，以便不同设置。
|
||||
|
||||
#### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.isPlatformIOS()
|
||||
|
||||
#### 代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()) {
|
||||
// iOS
|
||||
} else {
|
||||
// Android
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
## iOS 手动安装
|
||||
|
||||
- 下载 JPush PhoneGap Plugin 插件，并解压
|
||||
|
||||
- 将 [/src/ios](/src/ios) 文件夹及内容在 xcode 中拖到你的工程里，并配置 [/src/ios/PushConfig.plist](/src/ios/PushConfig.plist) 中相应参数：
|
||||
|
||||
APP_KEY： 应用标识
|
||||
CHANNEL： 渠道标识
|
||||
IsProduction：是否生产环境
|
||||
IsIDFA： 是否使用 IDFA 启动 sdk
|
||||
|
||||
- 打开 xcode，点击工程目录中顶部的 工程，选择(Target -> Build Phases -> Link Binary With Libraries)，添加以下框架：
|
||||
|
||||
CFNetwork.framework
|
||||
CoreFoundation.framework
|
||||
CoreTelephony.framework
|
||||
SystemConfiguration.framework
|
||||
CoreGraphics.framework
|
||||
Foundation.framework
|
||||
UIKit.framework
|
||||
AdSupport.framework
|
||||
libz.tbd(若存在 libz.dylib 则替换为 libz.tbd)
|
||||
|
||||
- 修改 phonegap config.xml 文件以添加 JPushPlugin 插件
|
||||
|
||||
<feature name="JPushPlugin">
|
||||
<param name="ios-package" value="JPushPlugin" />
|
||||
<param name="onload" value="true" />
|
||||
</feature>
|
||||
|
||||
- 将 [/www/JPushPlugin.js](/www/JPushPlugin.js) 在 xcode 中拖到工程的 www 目录下面
|
||||
|
||||
- 在需要使用插件处加入以下代码，并根据 [iOS API](/doc/iOS_API.md) 文档说明调用相应接口
|
||||
|
||||
<script type="text/javascript" src="JPushPlugin.js"></script>
|
||||
Reference in New Issue
Block a user