mirror of
https://github.com/jpush/jpush-phonegap-plugin.git
synced 2026-05-27 00:00:12 +08:00
format doc
This commit is contained in:
Hevin
@@ -1,4 +1,4 @@
|
||||
## JPush PhoneGap/Cordova Plugin ##
|
||||
# JPush PhoneGap / Cordova Plugin
|
||||
|
||||
[](https://travis-ci.org/jpush/jpush-phonegap-plugin)
|
||||
[](https://gitter.im/jpush/jpush-phonegap-plugin)
|
||||
@@ -6,12 +6,9 @@
|
||||
[](https://github.com/jpush/jpush-phonegap-plugin-plugin)
|
||||
[](http://weibo.com/jpush?refer_flag=1001030101_&is_all=1)
|
||||
|
||||
JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。
|
||||
支持 iOS, Android 的 Cordova 推送插件。
|
||||
|
||||
**功能特性：**
|
||||
支持 iOS, Android 的极光推送插件。
|
||||
|
||||
### 功能特性
|
||||
## 功能特性
|
||||
+ 发送推送通知。
|
||||
+ 发送推送自定义消息。
|
||||
+ 设置推送标签和别名。
|
||||
@@ -26,74 +23,69 @@ JPush-PhoneGap-Plugin 支持 iOS, Android 的推送插件。
|
||||
|
||||
cordova create Myproj com.myproj.jpush MyTestProj
|
||||
|
||||
2. 添加平台
|
||||
2. 添加平台:
|
||||
|
||||
cd Myproj
|
||||
cordova platform add android
|
||||
cordova platform add ios
|
||||
|
||||
ps:这里请注意iOS平台，必须先执行 `cordova platform add ios`,
|
||||
然后再执行 `cordova plugin add xxxxx` 命令，不然有一些必须要的链接库需要手动添加
|
||||
ps: 这里请注意iOS平台，必须先执行 cordova platform add ios,
|
||||
然后再执行 cordova plugin add xxxxx 命令，不然有一些必须要的链接库需要手动添加。
|
||||
|
||||
|
||||
### Cordova CLI / PhoneGap 安装 Android & iOS
|
||||
### 安装插件(Android & iOS)
|
||||
|
||||
1). 安装 JPush PhoneGap Plugin, 有两种方法：
|
||||
#### 1.安装 JPush PhoneGap Plugin
|
||||
安装 JPush PhoneGap Plugin 有两种方法：
|
||||
|
||||
方法一：在线安装
|
||||
|
||||
通过 cordova plugins 安装，要求 phonegap/cordova CLI 5.0+
|
||||
通过 cordova plugins 安装，要求 phonegap/cordova CLI 5.0+:
|
||||
|
||||
cordova plugin add jpush-phonegap-plugin --variable API_KEY=your_jpush_appkey
|
||||
|
||||
直接通过 url 安装
|
||||
直接通过 url 安装:
|
||||
|
||||
cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable API_KEY=your_jpush_appkey
|
||||
|
||||
方法二：下载到本地再安装
|
||||
|
||||
使用 git 命令将 JPush PhoneGap 插件下载的本地,将这个目录标记为 `$JPUSH_PLUGIN_DIR`
|
||||
使用 git 命令将 JPush PhoneGap 插件下载的本地，目录标记为 $JPUSH_PLUGIN_DIR。
|
||||
|
||||
git clone https://github.com/jpush/jpush-phonegap-plugin.git
|
||||
cordova plugin add $JPUSH_PLUGIN_DIR --variable API_KEY=your_jpush_appkey
|
||||
|
||||
[Android 手动安装文档地址](API/Android_handle_install.md)
|
||||
|
||||
2). 安装 org.apache.cordova.device
|
||||
[IOS 手动安装文档地址](API/iOS_install.md)
|
||||
|
||||
|
||||
#### 2.安装 org.apache.cordova.device 插件
|
||||
|
||||
cordova plugin add org.apache.cordova.device
|
||||
|
||||
|
||||
3). 在 js 中调用函数,初始化 JPush SDK
|
||||
#### 3.在 js 中调用函数，初始化 JPush
|
||||
|
||||
//由于 PhoneGap 插件采用了 Lazy load 的特性，所以建议在 js 文件能执行的最开始就添加
|
||||
window.plugins.jPushPlugin.init();
|
||||
|
||||
|
||||
### Android 手动安装
|
||||
|
||||
[Android 手动安装文档地址](API/Android_handle_install.md)
|
||||
## Demo
|
||||
插件中包含示例 Demo。若想参考，可以在 $JPUSH_PLUGIN_DIR/example 文件夹内找到并拷贝以下文件:
|
||||
|
||||
src/example/index.html -> www/index.html
|
||||
src/example/css/* -> www/css
|
||||
src/example/js/* -> www/js
|
||||
|
||||
### iOS 手动安装
|
||||
## 关于 PhoneGap build 云服务
|
||||
|
||||
[IOS 手动安装文档地址](API/iOS_install.md)
|
||||
|
||||
|
||||
### 示例
|
||||
|
||||
"$JPUSH_PLUGIN_DIR/example"文件夹内找到并拷贝以下文件
|
||||
|
||||
src/example/index.html to www/index.html
|
||||
src/example/css/* to www/css
|
||||
src/example/js/* to www/js
|
||||
|
||||
### 关于'PhoneGap build'云服务
|
||||
|
||||
该项目基于 cordova 实现，目前无法使用 'PhoneGap build' 云服务进行打包，建议使用本地环境进行打包
|
||||
该项目基于 cordova 实现，目前无法使用 PhoneGap build 云服务进行打包，建议使用本地环境进行打包。
|
||||
|
||||
## API 说明
|
||||
|
||||
插件的 API 集中在 JPushPlugin.js 文件中,该文件的具体位置如下：
|
||||
插件的 API 集中在 JPushPlugin.js 文件中，该文件的具体位置如下：
|
||||
|
||||
Android:
|
||||
|
||||
@@ -112,29 +104,35 @@ iOS:
|
||||
- [Android API](https://github.com/jpush/jpush-phonegap-plugin/blob/dev/API/Android_detail_api.md)
|
||||
|
||||
|
||||
### 常见问题
|
||||
## 常见问题
|
||||
|
||||
若要使用 CLI 来编译项目，注意使用 cordova compile 而不是 cordova build，因为 cordova build 会覆盖掉对插件的修改。
|
||||
若要使用 CLI 来编译项目，注意使用 cordova compile 而不是 cordova build，因为 cordova build 会清除对插件文件的修改。
|
||||
具体 cordova CLI 用法可参考[cordova CLI 官方文档](https://cordova.apache.org/docs/en/latest/reference/cordova-cli/index.html)。
|
||||
|
||||
#### 1. Android
|
||||
### 1. Android
|
||||
|
||||
eclipse 中 PhoneGap 工程 import 之后出现：`Type CallbackContext cannot be resolved to a type`
|
||||
解决方案：eclipse 中右键单击工程名，Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add
|
||||
eclipse 中 import PhoneGap 工程之后出现：`Type CallbackContext cannot be resolved to a type`。
|
||||
|
||||
#### 2. iOS
|
||||
解决方案：eclipse 中右键单击工程名，Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add。
|
||||
|
||||
- 设置 / 修改 APP_KEY
|
||||
### 2. iOS
|
||||
|
||||
- 设置 / 修改 APP_KEY:
|
||||
|
||||
在 PushConfig.plist 中修改。
|
||||
PushConfig.plist 其他值说明：
|
||||
CHANNEL: 渠道标识
|
||||
IsProduction: 是否生产环境（暂未启用）
|
||||
PushConfig.plist 中其他值说明：
|
||||
|
||||
- 收不到推送
|
||||
- CHANNEL: 渠道标识。
|
||||
- IsProduction: 是否生产环境（暂未启用）。
|
||||
|
||||
|
||||
- 收不到推送:
|
||||
|
||||
请首先按照正确方式再次配置证书、描述文件
|
||||
[iOS 证书 设置指南](http://docs.jpush.io/client/ios_tutorials/#ios_1)
|
||||
[iOS 证书设置指南](http://docs.jpush.io/client/ios_tutorials/#ios_1)。
|
||||
|
||||
|
||||
### 更多
|
||||
## 更多
|
||||
[JPush 官网文档](http://docs.jpush.io/)
|
||||
|
||||
如有问题可访问[极光社区](http://community.jpush.cn/)
|
||||
|
||||
Reference in New Issue
Block a user