JPush PhoneGap/Cordova 插件使用教程

JPush PhoneGap/Cordova 插件使用教程

jpush-phonegap-pluginJPush's officially supported PhoneGap/Cordova plugin (Android & iOS). 极光推送官方支持的 PhoneGap/Cordova 插件（Android & iOS）。项目地址:https://gitcode.com/gh_mirrors/jp/jpush-phonegap-plugin

1. 项目的目录结构及介绍

JPush PhoneGap/Cordova 插件的目录结构如下：

jpush-phonegap-plugin/
├── doc/
├── example/
├── hooks/
├── ionic/
├── src/
│   ├── android/
│   └── ios/
├── www/
├── .gitignore
├── .travis.yml
├── README.md
├── issue_template.md
├── license
├── package.json
└── plugin.xml

目录介绍

• doc/: 包含插件的文档文件。
• example/: 包含插件的使用示例。
• hooks/: 包含 Cordova 钩子脚本。
• ionic/: 包含 Ionic 框架的相关文件。
• src/: 包含插件的源代码，分为 Android 和 iOS 两个子目录。
• www/: 包含插件的 Web 资源文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• README.md: 项目说明文档。
• issue_template.md: GitHub 问题模板。
• license: 项目许可证。
• package.json: Node.js 包配置文件。
• plugin.xml: Cordova 插件配置文件。

2. 项目的启动文件介绍

JPush PhoneGap/Cordova 插件的启动文件主要位于 www/ 目录下，其中 JPushPlugin.js 是核心启动文件。

启动文件介绍

• www/JPushPlugin.js: 该文件是插件的主要 JavaScript 接口，提供了初始化和配置 JPush 服务的功能。

// 示例代码
document.addEventListener('deviceready', function() {
    window.JPush.init();
}, false);

3. 项目的配置文件介绍

JPush PhoneGap/Cordova 插件的配置文件主要包括 plugin.xml 和 package.json。

配置文件介绍

• plugin.xml: 该文件定义了插件的元数据、平台依赖和文件映射。

<!-- 示例代码 -->
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="jpush-phonegap-plugin"
        version="4.8.5">
    <name>JPushPlugin</name>
    <js-module src="www/JPushPlugin.js" name="JPushPlugin">
        <clobbers target="window.JPush" />
    </js-module>
    <platform name="android">
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="JPushPlugin">
                <param name="android-package" value="cn.jpush.phonegap.JPushPlugin"/>
            </feature>
        </config-file>
        <source-file src="src/android/cn/jpush/phonegap/JPushPlugin.java" target-dir="src/cn/jpush/phonegap"/>
    </platform>
    <platform name="ios">
        <config-file target="config.xml" parent="/*">
            <feature name="JPushPlugin">
                <param name="ios-package" value="JPushPlugin"/>
            </feature>
        </config-file>
        <source-file src="src/ios/JPushPlugin.m" />
    </platform>
</plugin>

• package.json: 该文件定义了 Node.js 包的元数据和依赖。

{
  "name": "jpush-phonegap-plugin",
  "version": "4.8.5",
  "description": "JPush's officially supported PhoneGap/Cordova plugin (Android & iOS)",
  "cordova": {
    "id": "jpush-phonegap-plugin",
    "platforms": [
      "android",
      "ios"
    ]
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/jpush/jpush-phonegap-plugin.git"
  },
  "keywords": [
    "ecosystem:cordova",

jpush-phonegap-pluginJPush's officially supported PhoneGap/Cordova plugin (Android & iOS). 极光推送官方支持的 PhoneGap/Cordova 插件（Android & iOS）。项目地址:https://gitcode.com/gh_mirrors/jp/jpush-phonegap-plugin