jpush-phonegap-plugin/README.md
2016-07-13 22:03:35 +08:00

3.6 KiB
Raw Blame History

JPush PhoneGap / Cordova Plugin

Build Status QQ Group release platforms weibo

支持 iOS, Android 的 Cordova 推送插件。

如需要 IM 功能的插件,可关注 JMessage PhoneGap Plugin

QQ 交流群413602425

集成步骤

集成 JPush PhoneGap Plugin 有两种方法:

在线安装

  • 通过 Cordova Plugins 安装,要求 PhoneGap/Cordova CLI 5.0+

      cordova plugin add jpush-phonegap-plugin --variable API_KEY=your_jpush_appkey
    
  • 直接通过 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 clone https://github.com/jpush/jpush-phonegap-plugin.git

cordova plugin add $JPUSH_PLUGIN_DIR  --variable API_KEY=your_jpush_appkey

Demo

插件项目中包含一个简单的 Demo。若想参考可以在 /example 文件夹内找到并拷贝以下文件:

src/example/index.html -> www/index.html
src/example/css/* -> www/css
src/example/js/* -> www/js

关于 PhoneGap build 云服务

该项目基于 Cordova 实现,目前无法使用 PhoneGap build 云服务进行打包,建议使用本地环境进行打包。

API 说明

插件的 API 在 JPushPlugin.js 文件中,该文件的具体位置如下:

Android

[Project]/assets/www/plugins/cn.jpush.phonegap.JPushPlugin/www

iOS

[Project]/www/plugins/cn.jpush.phonegap.JPushPlugin/www

具体的 API 请参考:

常见问题

若要使用 CLI 来编译项目,注意应使用 cordova compile 而不是 cordova build 命令,因为如果修改了插件安装时默认写入到 AndroidManifest.xml 中的代码cordova build 可能会导致对 AndroidManifest.xml 的修改。 Cordova CLI 的具体用法可参考 Cordova CLI 官方文档

1. Android

  • Eclipse 中 import PhoneGap 工程之后出现:Type CallbackContext cannot be resolved to a type

    解决方案Eclipse 中右键单击工程名Build Path -> Config Build Path -> Projects -> 选中工程名称 -> CordovaLib -> 点击 add。

  • 最新版插件依赖 android-support-v4:24.0.0 jar 包,需要及时更新 Android Support Repository

2. iOS

  • 收不到推送: 请首先按照正确方式再次配置证书、描述文件,具体可参考 iOS 证书设置指南

  • 设置 PushConfig.plist

    • APP_KEY应用标识。
    • CHANNEL渠道标识。
    • IsProduction是否生产环境。
    • IsIDFA是否使用 IDFA 启动 SDK。

更多