Cordova Badge 插件使用教程

Cordova Badge 插件使用教程

cordova-plugin-badgeAccess and modify badge numbers项目地址:https://gitcode.com/gh_mirrors/co/cordova-plugin-badge

目录结构及介绍

cordova-plugin-badge/
├── src/
│   ├── android/
│   ├── ios/
│   └── windows/
├── www/
│   └── badge.js
├── plugin.xml
├── package.json
└── README.md

• src/: 包含不同平台的实现代码。
  • android/: Android 平台的实现代码。
  • ios/: iOS 平台的实现代码。
  • windows/: Windows 平台的实现代码。
• www/: 包含插件的 JavaScript 接口。
  • badge.js: 插件的主要 JavaScript 文件。
• plugin.xml: 插件的配置文件，定义插件的元数据和依赖关系。
• package.json: 插件的 npm 包配置文件。
• README.md: 插件的说明文档。

项目的启动文件介绍

插件的启动文件主要是 www/badge.js，它定义了插件的 JavaScript 接口。以下是 badge.js 的主要内容：

var exec = require('cordova/exec');

var Badge = {
    set: function(badge, successCallback, errorCallback) {
        exec(successCallback, errorCallback, "Badge", "set", [badge]);
    },
    get: function(successCallback, errorCallback) {
        exec(successCallback, errorCallback, "Badge", "get", []);
    },
    clear: function(successCallback, errorCallback) {
        exec(successCallback, errorCallback, "Badge", "clear", []);
    }
};

module.exports = Badge;

• set: 设置应用图标的角标数字。
• get: 获取当前应用图标的角标数字。
• clear: 清除应用图标的角标数字。

项目的配置文件介绍

plugin.xml

plugin.xml 文件定义了插件的元数据和依赖关系。以下是 plugin.xml 的主要内容：

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="cordova-plugin-badge"
        version="0.8.8">
    <name>Badge</name>
    <description>Cordova Badge Plugin</description>
    <license>MIT</license>
    <keywords>cordova,badge,icon</keywords>
    <js-module src="www/badge.js" name="badge">
        <clobbers target="cordova.plugins.badge" />
    </js-module>
    <platform name="android">
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="Badge">
                <param name="android-package" value="de.appplant.cordova.plugin.badge.Badge"/>
            </feature>
        </config-file>
        <source-file src="src/android/Badge.java" target-dir="src/de/appplant/cordova/plugin/badge"/>
    </platform>
    <platform name="ios">
        <config-file target="config.xml" parent="/*">
            <feature name="Badge">
                <param name="ios-package" value="CDVBAdge"/>
            </feature>
        </config-file>
        <header-file src="src/ios/CDVBadge.h"/>
        <source-file src="src/ios/CDVBadge.m"/>
    </platform>
    <platform name="windows">
        <js-module src="src/windows/BadgeProxy.js" name="BadgeProxy">
            <clobbers target="cordova.plugins.badge" />
        </js-module>
        <config-file target="config.xml" parent="/*">
            <feature name="Badge">
                <param name="onload" value="true"/>
                <param name="uri" value="/www/src/windows/BadgeProxy.js"/>
            </feature>
        </config-file>
    </platform>
</plugin>

• id: 插件的唯一标识符。
• version: 插件的版本号。
• js-module:

cordova-plugin-badgeAccess and modify badge numbers项目地址:https://gitcode.com/gh_mirrors/co/cordova-plugin-badge