统一 API,规范代码格式

- setDebugMode
- clearLocalNotifications
This commit is contained in:
Hevin Lau
2017-01-17 22:59:13 +08:00
parent 7b65a1f469
commit 42790c71f3
4 changed files with 171 additions and 159 deletions

View File

@@ -3,7 +3,7 @@
- [接收通知时获得通知的内容](#接收通知时获得通知的内容)
- [打开通知时获得通知的内容](#打开通知时获得通知的内容)
- [收到自定义消息时获取消息的内容](#收到自定义消息时获取消息的内容)
- [获取集成日志](#获取集成日志)
- [获取集成日志(适用于 iOS](#获取集成日志(适用于 iOS)
- [接收消息和点击通知事件](#接收消息和点击通知事件)
- [统计分析](#统计分析)
- [清除通知](#清除通知)
@@ -39,7 +39,7 @@
- 附加字段:
window.plugins.jPushPlugin.receiveMessage.extras.yourKey
## 获取集成日志
## 获取集成日志(适用于 iOS
### API - setDebugMode
@@ -250,21 +250,20 @@ JPush SDK 提供了 2 个用于定制通知栏样式的构建类:
## 本地通知
### API - addLocalNotification, removeLocalNotification, clearLocalNotifications
本地通知 API 不依赖于网络,无网条件下依旧可以触发。
本地通知与网络推送的通知是相互独立的,不受保留最近通知条数上限的限制。
本地通知的定时时间是自发送时算起的,不受中间关机等操作的影响。
三个接口的功能分别为:添加一个本地通知,除一个本地通知,除所有的本地通知。
三个接口的功能分别为:添加一个本地通知,除一个本地通知,除所有的本地通知。
#####接口定义
#### 接口定义
window.plugins.jPushPlugin.addLocalNotification(builderId, content, title,
notificaitonID, broadcastTime, extras)
window.plugins.jPushPlugin.removeLocalNotification(notificationID)
window.plugins.jPushPlugin.clearLocalNotifications()
window.plugins.jPushPlugin.clearLocalNotifications() // 同时适用于 iOS
#### 参数说明

View File

@@ -1,4 +1,4 @@
# 通用 API 说明
# 通用 API 说明(同时适用于 Android 和 iOS 系统)
- [停止与恢复推送服务](#停止与恢复推送服务)
- [获取 RegistrationID](#获取-registrationid)
@@ -45,7 +45,6 @@
window.plugins.jPushPlugin.stopPush()
### API - resumePush
恢复推送服务。调用了此 API 后:
@@ -72,7 +71,6 @@
+ 平台检查推送服务是否注册。
#### 接口定义
window.plugins.jPushPlugin.isPushStopped(callback)
@@ -91,6 +89,20 @@
}
})
## 开启 Debug 模式
### API - setDebugMode
用于开启 Debug 模式,显示更多的日志信息。
#### 接口定义
JPushPlugin.prototype.setDebugMode(isOpen)
#### 参数说明
- isOpen: true开启 Debug 模式false关闭 Debug 模式,不显示错误信息之外的日志信息。
#### 代码示例
window.plugins.jPushPlugin.setDebugMode(true)
## 获取 RegistrationID
@@ -266,7 +278,7 @@ JPush SDK 会以广播的形式发送 RegistrationID 到应用程序。
}
alert("open Notificaiton:" + alertContent)
}, false)
> ps点击通知后传递的 json object 保存在 window.plugins.jPushPlugin.receiveNotification直接访问即可字段示例根据实际推送情况可能略有差别请注意。