mirror of
https://github.com/jpush/jpush-phonegap-plugin.git
synced 2024-10-06 17:42:11 +08:00
Update iOS_detail_api.md
1.修正原先的小错误 2.添加新的接口：本地推送等。
This commit is contained in:
Pikachuode
parent
ff090d63f6
commit
41bb3f871e
@ -30,9 +30,9 @@
|
||||
本 API 用于“用户指定页面使用时长”的统计，并上报到服务器，在 Portal 上展示给开发者。页面统计集成正确，才能够获取正确的页面访问路径、访问深度（PV）的数据。
|
||||
|
||||
##### 接口定义
|
||||
window.plugins.jPushPlugin.startLogPageView = function(pageName)
|
||||
window.plugins.jPushPlugin.stopLogPageView = function(pageName)
|
||||
window.plugins.jPushPlugin.beginLogPageView = function(pageName,duration)
|
||||
window.plugins.jPushPlugin.prototype.startLogPageView = function(pageName)
|
||||
window.plugins.jPushPlugin.prototype.stopLogPageView = function(pageName)
|
||||
window.plugins.jPushPlugin.prototype.beginLogPageView = function(pageName,duration)
|
||||
#####参数说明
|
||||
pageName 需要统计页面自定义名称
|
||||
duration 自定义的页面时间
|
||||
@ -44,11 +44,10 @@ duration 自定义的页面时间
|
||||
无
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
window.plugins.jPushPlugin.beginLogPageView("newPage",5);
|
||||
window.plugins.jPushPlugin.startLogPageView("onePage");
|
||||
window.plugins.jPushPlugin.stopLogPageView("onePage");
|
||||
}
|
||||
window.plugins.jPushPlugin.beginLogPageView("newPage",5);
|
||||
window.plugins.jPushPlugin.startLogPageView("onePage");
|
||||
window.plugins.jPushPlugin.stopLogPageView("onePage");
|
||||
|
||||
### 设置Badge
|
||||
#### API - setBadge,resetBadge
|
||||
|
||||
@ -58,8 +57,8 @@ duration 自定义的页面时间
|
||||
实际应用中，开发者可以直接对badge值做增减操作，无需自己维护用户与badge值之间的对应关系。
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setBadge(value)
|
||||
window.plugins.jPushPlugin.reSetBadge()
|
||||
window.plugins.jPushPlugin.prototype.setBadge(value)
|
||||
window.plugins.jPushPlugin.prototype.reSetBadge()
|
||||
|
||||
`resetBadge相当于setBadge(0)`
|
||||
##### 参数说明
|
||||
@ -68,10 +67,8 @@ value 取值范围：[0,99999]
|
||||
无，控制台会有log打印设置结果
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
window.plugins.jPushPlugin.setBadge(5);
|
||||
window.plugins.jPushPlugin.reSetBadge();
|
||||
}
|
||||
window.plugins.jPushPlugin.setBadge(5);
|
||||
window.plugins.jPushPlugin.reSetBadge();
|
||||
|
||||
#### API - setApplicationIconBadgeNumber
|
||||
|
||||
@ -80,7 +77,7 @@ value 取值范围：[0,99999]
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(badge)
|
||||
window.plugins.jPushPlugin.prototype.setApplicationIconBadgeNumber(badge)
|
||||
|
||||
##### 参数说明
|
||||
|
||||
@ -89,9 +86,7 @@ value 取值范围：[0,99999]
|
||||
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0);
|
||||
}
|
||||
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(0);
|
||||
|
||||
|
||||
#### API - getApplicationIconBadgeNumber
|
||||
@ -100,7 +95,7 @@ value 取值范围：[0,99999]
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.getApplicationIconBadgeNumber(callback)
|
||||
window.plugins.jPushPlugin.prototype.getApplicationIconBadgeNumber(callback)
|
||||
|
||||
##### 参数说明
|
||||
|
||||
@ -116,7 +111,56 @@ window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data){
|
||||
```
|
||||
|
||||
### 本地通知
|
||||
#### API - addLocalNotificationForIOS
|
||||
|
||||
API用于注册本地通知
|
||||
|
||||
最多支持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
|
||||
|
||||
API删除本地推送定义
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.deleteLocalNotificationWithIdentifierKeyInIOS(identifierKey)
|
||||
|
||||
##### 参数说明
|
||||
|
||||
- identifierKey 本地推送标识符
|
||||
|
||||
#####代码示例
|
||||
|
||||
window.plugins.jPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS("identifier")
|
||||
|
||||
#### API - clearAllLocalNotifications
|
||||
|
||||
API清除所有本地推送对象
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.clearAllLocalNotifications()
|
||||
|
||||
#####代码示例
|
||||
|
||||
window.plugins.jPushPlugin.clearAllLocalNotifications()
|
||||
|
||||
### 日志等级设置
|
||||
#### API - setDebugModeFromIos
|
||||
API 用于开启Debug模式，显示更多的日志信息
|
||||
@ -124,13 +168,11 @@ API 用于开启Debug模式，显示更多的日志信息
|
||||
建议调试时开启这个选项，不调试的时候注释这句代码，这个函数setLogOFF是相反的一对
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.reSetBadge.setDebugModeFromIos()
|
||||
window.plugins.jPushPlugin.prototype.setDebugModeFromIos()
|
||||
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
window.plugins.jPushPlugin.setDebugModeFromIos();
|
||||
}
|
||||
window.plugins.jPushPlugin.setDebugModeFromIos();
|
||||
|
||||
#### API - setLogOFF
|
||||
|
||||
@ -140,11 +182,39 @@ API用来关闭日志信息（除了必要的错误信息）
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.reSetBadge.setLogOFF ()
|
||||
window.plugins.jPushPlugin.prototype.setLogOFF ()
|
||||
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
window.plugins.jPushPlugin.setLogOFF();
|
||||
}
|
||||
window.plugins.jPushPlugin.setLogOFF();
|
||||
|
||||
#### API - setCrashLogON
|
||||
|
||||
API用于统计用户应用崩溃日志
|
||||
|
||||
如果需要统计Log信息，调用该接口。当你需要自己收集错误信息时，切记不要调用该接口。
|
||||
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.setCrashLogON ()
|
||||
|
||||
#####代码示例
|
||||
|
||||
window.plugins.jPushPlugin.setCrashLogON()
|
||||
|
||||
### 设备平台判断
|
||||
#### API - isPlatformIOS
|
||||
API 用于区分iOS、Android平台，以便不同设置
|
||||
|
||||
##### 接口定义
|
||||
|
||||
window.plugins.jPushPlugin.prototype.isPlatformIOS()
|
||||
|
||||
#####代码示例
|
||||
|
||||
if(window.plugins.jPushPlugin.isPlatformIOS()){
|
||||
//iOS
|
||||
}else{
|
||||
//Android
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user