JPush PhoneGap / Cordova Plugin

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

功能特性

• 发送推送通知。
• 发送推送自定义消息。
• 设置推送标签和别名。
• 设置角标（iOS）。

如需要 IM 功能插件，请关注 jmessage-phonegap-plugin。

安装

准备工作

1. cordova create 文件夹名字 包名 应用名字

    cordova create Myproj com.myproj.jpush MyTestProj

2. 添加平台:

    cd Myproj
    cordova platform add android  
    cordova platform add ios
   
    ps: 这里请注意iOS平台，必须先执行 cordova platform add ios,
    然后再执行 cordova plugin add xxxxx 命令，不然有一些必须要的链接库需要手动添加。

安装插件(Android & iOS)

1.安装 JPush PhoneGap Plugin

安装 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

Android 手动安装文档地址

IOS 手动安装文档地址

2.安装 cordova device 插件

 cordova plugin add cordova-plugin-device

3.在 js 中调用函数，初始化 JPush

//由于 PhoneGap 插件采用了 Lazy load 的特性，所以建议在 js 文件能执行的最开始就添加
window.plugins.jPushPlugin.init();

Demo

插件中包含示例 Demo。若想参考，可以在 $JPUSH_PLUGIN_DIR/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 请参考：

• 公共 API

• iOS API

• Android API

常见问题

若要使用 CLI 来编译项目，注意使用 cordova compile 而不是 cordova build，因为 cordova build 会清除对插件文件的修改。 具体 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。

2. iOS

• 收不到推送:

  请首先按照正确方式再次配置证书、描述文件 iOS 证书设置指南

• 设置 PushConfig.plist：

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

更多

JPush 官网文档

如有问题可访问极光社区