mirror of
https://github.com/jpush/jpush-phonegap-plugin.git
synced 2025-01-31 06:22:50 +08:00
update README.md
1.更新 README.md 2.更新 iOS_install.md
This commit is contained in:
E.B
parent
a599a02a14
commit
8b481ddd92
@ -23,8 +23,8 @@
|
||||
|
||||
10. 在 AppDelegate.m 中包含头文件
|
||||
|
||||
#import "APService.h"
|
||||
#import "JPushPlugin.h"
|
||||
#import "JPUSHService.h"
|
||||
#import "JPushPlugin.h"
|
||||
|
||||
6. 调用代码,监听系统事件，相应地调用 JPush SDK 提供的 API 来实现功能
|
||||
|
||||
@ -37,12 +37,12 @@
|
||||
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
|
||||
//原内容保持不变
|
||||
// Required add
|
||||
[APService registerDeviceToken:deviceToken];
|
||||
[JPUSHService registerDeviceToken:deviceToken];
|
||||
}
|
||||
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
|
||||
//原内容保持不变
|
||||
// Required
|
||||
[APService handleRemoteNotification:userInfo];
|
||||
// Required add
|
||||
[JPUSHService handleRemoteNotification:userInfo];
|
||||
[[NSNotificationCenter defaultCenter] postNotificationName:kJPushPluginReceiveNotification
|
||||
object:userInfo];
|
||||
}
|
||||
133
README.md
133
README.md
@ -85,7 +85,7 @@ JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。
|
||||
|
||||
该项目基于 cordova 实现，目前无法使用 'PhoneGap build' 云服务进行打包，建议使用本地环境进行打包
|
||||
|
||||
### API 说明
|
||||
## API 说明
|
||||
|
||||
插件的 API 集中在 JPushPlugin.js 文件中,该文件的具体位置如下：
|
||||
|
||||
@ -97,128 +97,14 @@ iOS:
|
||||
|
||||
[Project]/www/plugins/cn.jpush.phonegap.JPushPlugin/www
|
||||
|
||||
具体的 API 请参考下面：
|
||||
### 具体的 API 请参考：
|
||||
|
||||
#### iOS 和 Android 通用 API 简介
|
||||
- [公共 API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/Common_detail_api.md)
|
||||
|
||||
+ 停止与恢复推送服务
|
||||
- [iOS API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/iOS%20API.md)
|
||||
|
||||
window.plugins.jPushPlugin.init()
|
||||
window.plugins.jPushPlugin.stopPush()
|
||||
window.plugins.jPushPlugin.resumePush()
|
||||
window.plugins.jPushPlugin.isPushStopped(callback)
|
||||
- [Android API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/Android_detail_api.md)
|
||||
|
||||
+ 获取 RegistrationID
|
||||
|
||||
window.plugins.jPushPlugin.getRegistrationID(callback)
|
||||
|
||||
+ 别名与标签
|
||||
|
||||
window.plugins.jPushPlugin.setTagsWithAlias(tags, alias)
|
||||
window.plugins.jPushPlugin.setTags(tags)
|
||||
window.plugins.jPushPlugin.setAlias(alias)
|
||||
|
||||
event - jpush.setTagsWithAlias //三个方法都是触发该回调事件
|
||||
|
||||
+ 获取点击通知内容
|
||||
|
||||
event - jpush.openNotification
|
||||
|
||||
+ 获取通知内容
|
||||
|
||||
event - jpush.receiveNotification
|
||||
|
||||
+ 获取自定义消息推送内容
|
||||
|
||||
event - jpush.receiveMessage
|
||||
|
||||
|
||||
[通用 API 详细说明](document/Common_detail_api.md)
|
||||
|
||||
#### iOS API简介
|
||||
|
||||
+ 获取自定义消息推送内容
|
||||
|
||||
//推荐使用事件的方式传递，但同时保留了 receiveMessageIniOSCallback 的回调函数，兼容以前的代码
|
||||
window.plugins.jPushPlugin.receiveMessageIniOSCallback(data)
|
||||
|
||||
event - jpush.receiveMessage
|
||||
|
||||
+ 页面的统计
|
||||
|
||||
window.plugins.jPushPlugin.startLogPageView(pageName)
|
||||
window.plugins.jPushPlugin.stopLogPageView(pageName)
|
||||
window.plugins.jPushPlugin.beginLogPageView(pageName, duration)
|
||||
|
||||
+ 设置 Badge
|
||||
|
||||
window.plugins.jPushPlugin.setBadge(value)
|
||||
window.plugins.jPushPlugin.resetBadge()
|
||||
window.plugins.jPushPlugin.setApplicationIconBadgeNumber(badge)
|
||||
window.plugins.JPushPlugin.getApplicationIconBadgeNumber(callback)
|
||||
|
||||
+ 本地通知
|
||||
|
||||
window.plugins.JPushPlugin.addLocalNotificationForIOS(delayTime, content,
|
||||
badge, notificationID, extras)
|
||||
window.plugins.JPushPlugin.deleteLocalNotificationWithIdentifierKeyInIOS()
|
||||
window.plugins.JPushPlugin.clearAllLocalNotifications()
|
||||
|
||||
+ 日志等级设置
|
||||
|
||||
window.plugins.jPushPlugin.setDebugModeFromIos()
|
||||
window.plugins.jPushPlugin.setLogOFF()
|
||||
window.plugins.JPushPlugin.setCrashLogON()
|
||||
|
||||
+ 地理位置上报
|
||||
|
||||
window.plugins.JPushPlugin.setLocation(latitude, longitude)
|
||||
|
||||
[iOS API 详细说明](document/iOS_detail_api.md)
|
||||
|
||||
|
||||
#### Android API简介
|
||||
|
||||
+ 获取集成日志
|
||||
|
||||
window.plugins.jPushPlugin.setDebugMode(mode)
|
||||
|
||||
+ 接收推送消息和点击通知
|
||||
|
||||
//下面这两个 API 是兼容旧有的代码
|
||||
window.plugins.jPushPlugin.receiveMessageInAndroidCallback(data)
|
||||
window.plugins.jPushPlugin.openNotificationInAndroidCallback(data)
|
||||
|
||||
+ 统计分析
|
||||
|
||||
window.plugins.jPushPlugin.setStatisticsOpen(boolean)
|
||||
|
||||
或在 MainActivity 中的 onPause() 和 onResume() 方法中分别调用
|
||||
JPushInterface.onPause(this) 和 JPushInterface.onResume(this) 来启用统计分析功能,
|
||||
如果使用这种方式启用统计分析功能，则 window.plugins.jPushPlugin.setStatisticsOpen(boolean)
|
||||
方法不再有效，建议不要同时使用。
|
||||
|
||||
+ 清除通知
|
||||
|
||||
window.plugins.jPushPlugin.clearAllNotification()
|
||||
|
||||
+ 通知栏样式定制
|
||||
|
||||
window.plugins.jPushPlugin.setBasicPushNotificationBuilder = function()
|
||||
window.plugins.jPushPlugin.setCustomPushNotificationBuilder = function()
|
||||
|
||||
+ 设置保留最近通知条数
|
||||
|
||||
window.plugins.jPushPlugin.setLatestNotificationNum(num)
|
||||
|
||||
+ 本地通知
|
||||
|
||||
window.plugins.jPushPlugin.addLocalNotification(builderId, content,
|
||||
title, notificaitonID, broadcastTime, extras)
|
||||
window.plugins.jPushPlugin.removeLocalNotification(notificationID)
|
||||
window.plugins.jPushPlugin.clearLocalNotifications()
|
||||
|
||||
[Android API 详细说明](document/Android_detail_api.md)
|
||||
|
||||
###常见问题
|
||||
|
||||
@ -227,13 +113,20 @@ iOS:
|
||||
eclipse 中 PhoneGap 工程 import 之后出现：`Type CallbackContext cannot be resolved to a type`
|
||||
解决方案：eclipse 中右键单击工程名，Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add
|
||||
|
||||
####2. iOS 设置 / 修改 APP_KEY
|
||||
####2. iOS
|
||||
|
||||
- 设置 / 修改 APP_KEY
|
||||
|
||||
在 PushConfig.plist 中修改。
|
||||
PushConfig.plist 其他值说明：
|
||||
CHANNEL: 渠道标识
|
||||
IsProduction: 是否生产环境（暂未启用）
|
||||
|
||||
- 收不到推送
|
||||
|
||||
请首先按照正确方式再次配置证书、描述文件
|
||||
[iOS 证书 设置指南](http://docs.jpush.io/client/ios_tutorials/#ios_1)
|
||||
|
||||
|
||||
###更多
|
||||
[JPush 官网文档](http://docs.jpush.io/)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user