optimize code & update doc

rename some functions name.
format doc & make some instructions more clearer.
This commit is contained in:
Hevin
2016-04-11 15:21:59 +08:00
parent 46b2a5ab1a
commit b515caf1e4
6 changed files with 107 additions and 107 deletions
+53 -25
View File
@@ -1,12 +1,36 @@
## Android API简介
### 接收通知时获得通知的信息
- 内容
window.plugins.jPushPlugin.receiveNotification.alert;
- 标题
window.plugins.jPushPlugin.receiveNotification.title;
- 附加字段
window.plugins.jPushPlugin.receiveNotification.extras.yourKey;
### 打开通知时获得通知的信息
- 内容
window.plugins.jPushPlugin.openNotification.alert;
- 标题
window.plugins.jPushPlugin.openNotification.title;
- 附加字段
window.plugins.jPushPlugin.openNotification.extras.yourKey;
### 收到自定义消息时获得通知的信息
- 内容
window.plugins.jPushPlugin.openNotification.message;
- 附加字段
window.plugins.jPushPlugin.openNotification.extras.yourKey;
### 获取集成日志
#### API - setDebugMode
用于开启调试模式,可以查看集成 JPush 过程中的 Log,如果集成失败,可方便定位问题所在
用于开启调试模式,可以查看集成 JPush 过程中的 Log,如果集成失败,可方便定位问题所在
##### 接口定义
@@ -23,27 +47,28 @@
### 接收消息和点击通知事件
#### API - receiveMessageInAndroidCallback
用于 Android 收到应用内消息的回调函数(请注意和通知的区别),该函数不需要主动调用
用于 Android 收到应用内消息的回调函数(请注意和通知的区别),该函数不需要主动调用
##### 接口定义
window.plugins.jPushPlugin.receiveMessageInAndroidCallback = function(data)
##### 参数说明
- data 接收到的 js 字符串,包含的 key:value 请进入该函数体查看
- data 接收到的 js 字符串,包含的 key:value 请进入该函数体查看。
##### 代码示例
#### API - openNotificationInAndroidCallback
当点击 Android 手机的通知栏进入应用程序时,会调用这个函数,这个函数不需要主动调用,是作为回调函数来用的
当点击 Android 手机的通知栏进入应用程序时,会调用这个函数,这个函数不需要主动调用,是作为回调函数来用的
##### 接口定义
window.plugins.jPushPlugin.openNotificationInAndroidCallback = function(data)
##### 参数说明
- data js字符串
##### 代码示例
@@ -51,18 +76,20 @@
### 统计分析 API
#### API - onResume / onPause
这是一个 android local api,不是 js 的 API,请注意
本 API 用于“用户使用时长”,“活跃用户”,“用户打开次数”的统计,并上报到服务器,在 Portal 上展示给开发者。
这是一个 Android Local API,不是 js 的 API,请注意
本 API 用于“用户使用时长”,“活跃用户”,“用户打开次数”的统计,并上报到服务器,在 Portal 上展示给开发者。
####接口定义
public static void onResume(final Activity activity)
public static void onPause(final Activity activity)
####参数说明
Activity activity 当前所在的 Activity。
Activity 当前所在的 Activity。
####调用说明
应在所有的 Activity 的 onResume / onPause 方法里调用。
@@ -74,6 +101,7 @@
super.onResume();
JPushInterface.onResume(this);
}
@Override
protected void onPause() {
super.onPause();
@@ -90,22 +118,22 @@
window.plugins.jPushPlugin.setStatisticsOpen(boolean)
#### 参数说明
- boolean
-true : 打开统计分析功能
-false: 关闭统计分析功能
- true : 打开统计分析功能
- false: 关闭统计分析功能
#### API - reportNotificationOpened
用于上报用户的通知栏被打开,或者用于上报用户自定义消息被展示等客户端需要统计的事件。
##### 接口定义
window.plugins.jPushPlugin.reportNotificationOpened(msgID)
##### 参数说明
- msgID
-收到的通知或者自定义消息的 id
- 收到的通知或者自定义消息的 id
### 清除通知 API
@@ -114,7 +142,7 @@
推送通知到客户端时,由 JPush SDK 展现通知到通知栏上。
此 API 提供清除通知的功能,包括:清除所有 JPush 展现的通知(不包括非 JPush SDK 展现的)
此 API 提供清除通知的功能,包括:清除所有 JPush 展现的通知(不包括非 JPush SDK 展现的)
##### 接口定义
@@ -131,9 +159,9 @@
极光 Push SDK 提供了 2 个用于定制通知栏样式的构建类:
- setBasicPushNotificationBuilder
- Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)
- Basic 用于定制 Android Notification 里的 defaults / flags / icon 等基础样式(行为)
- setCustomPushNotificationBuilder
- 继承 Basic 进一步让开发者定制 Notification Layout
- 继承 Basic 进一步让开发者定制 Notification Layout
如果不调用此方法定制,则极光 Push SDK 默认的通知栏样式是:Android 标准的通知栏提示。
@@ -166,14 +194,14 @@
#### API - addLocalNotification,removeLocalNotification,clearLocalNotifications
本地通知 API 不依赖于网络,无网条件下依旧可以触发
本地通知 API 不依赖于网络,无网条件下依旧可以触发
本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制
本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制
本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响
本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响
三个接口的功能分别为:添加一个本地通知,删除一个本地通知,删除所有的本地通知
三个接口的功能分别为:添加一个本地通知,删除一个本地通知,删除所有的本地通知
#####接口定义
@@ -184,9 +212,9 @@
##### 参数说明
- builderId 设置本地通知样式
- content 设置本地通知的 content
- title 设置本地通知的 title
- notificaitonID 设置本地通知的 ID
- broadcastTime 设置本地通知触发时间,为距离当前时间的数值,单位是毫秒
- extras 设置额外的数据信息 extras 为 json 字符串
- builderId 设置本地通知样式
- content 设置本地通知的 content
- title 设置本地通知的 title
- notificaitonID 设置本地通知的 ID
- broadcastTime 设置本地通知触发时间,为距离当前时间的数值,单位是毫秒
- extras 设置额外的数据信息 extras 为 json 字符串