mirror of
https://github.com/jpush/jpush-phonegap-plugin.git
synced 2026-04-19 00:03:45 +08:00
update doc
This commit is contained in:
Hevin
+117
-111
@@ -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 字符串。
|
||||
|
||||
Reference in New Issue
Block a user