fix document

This commit is contained in:
zhangqinghe 2014-07-10 15:46:30 +08:00
parent bfe0a76ae0
commit d55a46c54c

View File

@ -1,17 +1,16 @@
## JPush PhoneGap Plugin ##
###创建项目###
1. cordova create 文件夹名字 包名 应用名字
```
cordova create Myproj com.myproj.jpush MyTestProj
```
2. 添加平台
```
cd Myproj :不进行这一步可能会出现[RangeError:Maximum call stack size exceeded]
cordova platform add android
```
### Android自动安装 ###
### Android使用PhoneGap/Cordova CLI自动安装
1. 使用 phonegap 或者 cordova cli 添加插件(建议在git客户端下使用在windows 的cmd界面下 该命令提示git command line tool 不可用):
@ -24,24 +23,22 @@ cordova platform add android
####IOS使用PhoneGap/Cordova CLI自动安装
###IOS使用PhoneGap/Cordova CLI自动安装
1. 使用PhoneGap/Cordova CLI命令安装
```
cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git
cordova platforms add ios
cordova build ios
```
2. 修改Resources/PushConfig.plist文件
```
在APP_KEY和CHANNLE字段 分别添加您的appkey和channle
```
3.添加监听系统事件,相应地调用 JPush SDK 提供的 API 来实现功能
```
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
在APP_KEY和CHANNLE字段 分别添加您的appkey和channle
3. 添加监听系统事件,相应地调用 JPush SDK 提供的 API 来实现功能
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions{
self.window = [[[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]] autorelease];
self.window.backgroundColor = [UIColor whiteColor];
[self.window makeKeyAndVisible];
@ -61,8 +58,6 @@ cordova build ios
// Required
[APService handleRemoteNotification:userInfo];
}
```
###Android 手工安装###
1. 复制src/android/*.java 到cn/jpush/phonega/目录下(即cn.jpush.phonegap的包下)
@ -72,7 +67,6 @@ cordova build ios
5. 复制src/android/jpush_notification_icon.png 到res/drawable/
6. 修改 AndroidManifest.xml 在 manifest 节点下添加以下权限
```
<!-- Required 一些系统要求的权限,如访问网络等-->
<uses-permission android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"/>
<uses-permission android:name="android.permission.RECEIVE_USER_PRESENT"/>
@ -88,10 +82,9 @@ cordova build ios
<permission
android:name="$PACKAGE_NAME.permission.JPUSH_MESSAGE"
android:protectionLevel="signature"/>
```
7. 修改AndroidManifest.xml 在 manifest/application 节点下添加SDK相关组件声明
```
<activity
android:name="cn.jpush.android.ui.PushActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar"
@ -172,19 +165,16 @@ cordova build ios
<meta-data android:name="JPUSH_CHANNEL" android:value="developer-default"/>
<meta-data android:name="JPUSH_APPKEY" android:value="299d0fee887820e7d90a68b2"/>
```
### IOS手工安装
1. 添加src/ios/Plugins/到project中
2. 添加src/ios/lib/到project中
3. 设置 Search Paths 下的 User Header Search Paths 和 Library Search Paths
```
比如SDK文件夹默认为lib与工程文件在同一级目录下则都设置为"$(SRCROOT)/[文件夹名称]"即可。
```
4. 确认一下的框架是存在的(Target -> Build Phases -> Link Binary With Libraries)
```
CFNetwork.framework
CoreFoundation.framework
@ -193,16 +183,14 @@ SystemConfiguration.framework
CoreGraphics.framework
Foundation.framework
UIKit.framework
```
5. 在你的工程中创建一个新的Property List文件
```
并将其命名为PushConfig.plist填入Portal为你的应用提供的APP_KEY等参数
```
6. 调用代码,监听系统事件,相应地调用 JPush SDK 提供的 API 来实现功能
```
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
@ -231,29 +219,28 @@ UIKit.framework
// Required
[APService handleRemoteNotification:userInfo];
}
```
7. 修改phonegap config.xml文件用来包含Plugin/内的插件
```
<feature name="JPushPlugin">
<param name="ios-package" value="JPushPlugin" />
<param name="onload" value="true" />
</feature>
```
8. 复制www/PushNotification.js到工程的www目录下面
9. 在需要使用插件处加入
```
<script type="text/javascript" src="JPushPlugin.js"></script>
```
###示例
1. 完整的示例可以点击网页右侧的"Download Zip"下载,下载完成后在文件的"src/ios/example"文件夹内找到并拷贝以下文件
```
src/ios/example/index.html to www/index.html
src/ios/example/css/* to www/css
src/ios/example/js/* to www/js
```