jpush/jpush-phonegap-plugin

Fork: 350 Star: 925 (更新于 2024-10-27 18:40:08)

license: MIT

Language: JavaScript .

JPush's officially supported PhoneGap/Cordova plugin (Android & iOS). 极光推送官方支持的 PhoneGap/Cordova 插件（Android & iOS）。

最后发布版本： v4.8.5 ( 2022-12-23 17:32:59)

官方网址 GitHub网址

介绍
版本
相关

JPush PhoneGap / Cordova Plugin

极光官方支持的 cordova 推送插件。

如需要 IM 功能的插件，可关注 jmessage-phonegap-plugin
如需要短信验证码功能插件，可关注 cordova-plugin-jsms
如需要统计分析功能插件，可关注 cordova-plugin-janalytics

注意：插件从 v3.4.0 开始支持 cordova-android 7.0.0，因 cordova-android 7.0.0 修改了 Android 项目结构，因此不兼容之前的版本，升级前请务必注意。

如果需要在cordova-android 7.0.0之前版本集成最新插件，参照这篇文章

如果需要安装之前版本的插件，请先安装 v1.2.0 以下版本（建议安装 v1.1.12）的 cordova-plugin-jcore，再安装旧版本插件（比如 v3.3.2），否则运行会报错。

Cordova Android版本与原生版本对应表

Install

注意：

应用的包名一定要和 APP_KEY 对应应用的包名一致，否则极光推送服务无法注册成功。

在使用 8 或以上版本的 Xcode 调试 iOS 项目时，需要先在项目配置界面的 Capabilities 中打开 Push Notifications 开关。

通过 Cordova Plugins 安装，要求 Cordova CLI 5.0+：

cordova plugin add jpush-phonegap-plugin --variable APP_KEY=your_jpush_appkey

或直接通过 url 安装：

cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable APP_KEY=your_jpush_appkey

或下载到本地安装：

cordova plugin add Your_Plugin_Path --variable APP_KEY=your_jpush_appkey

参数

APP_KEY: 必须设置，JPush 上注册的包名对应的 Appkey
```
--variable APP_KEY=your_jpush_appkey
```
CHANNEL: 可以不设置，v3.6.0+ 版本开始支持(Android Only)，方便开发者统计 APK 分发渠道，默认为 developer-default.
```
--variable CHANNEL=your_channel
```

同时动态配置 APP_KEY 和 CHANNEL 示例

cordova plugin add jpush-phonegap-plugin --variable APP_KEY=your_jpush_appkey --variable CHANNEL=your_channel

Ionic

如果使用了 Ionic，可以再安装 @jiguang-ionic/jpush 包，适配 ionic-native：

npm install --save @jiguang-ionic/jpush@1.0.2

# npm install --save @jiguang-ionic/jpush@2.0.0 for ionic4+

然后在 app.module.ts 中增加：

// @jiguang-ionic/jpush@1.0.0+
import { JPush } from '@jiguang-ionic/jpush';

// @jiguang-ionic/jpush@2.0.0+
import { JPush } from '@jiguang-ionic/jpush/ngx';
...
  providers: [
    ...
    JPush,
    ...
  ]

具体可参考 ./ionic/example 中的文件。

Usage

API

Demo

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

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

关于 PhoneGap build 云服务

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

FAQ

如果遇到了疑问，请优先参考 Demo 和 API 文档。若还无法解决，可到 Issues 提问。

Android

在 Eclipse 中 import 工程之后出现：Type CallbackContext cannot be resolved to a type

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

无法获取到 Registration Id

检查 AppKey 和应用包名是否对应、是否调用了 init 方法。

如何自定义通知声音？

Android 因为各 Rom 的高度定制化，不像 iOS 一样能有一个统一的管理，如果在 Android 中想自定义通知铃声，推荐通过 JPush 推送自定义消息，之后在 jpush.receiveMessage 事件监听中通过 Cordova Local-Notification Plugin 触发通知，再配合 Cordova Background Plugin 插件保证应用的后台运行。