Cordova徽章插件

转自：https://www.npmjs.com/package/cordova-plugin-badge

Cordova插件可访问和修改各种移动平台（包括iOS，Android和Windows）上的应用程序图标的徽章编号。

它们如何出现在用户身上

用户通过以下方式查看通知：

• 粘贴应用程序的图标
• 进度指示器（基于https://github.com/hokein/DockProgressBar的 OSX ）

支持的平台

• Android / Amazon FireOS（通过ShortcutBadger）
• 浏览器（通过favico.js）
• iOS 10+
• OSX
• Windows（手机和桌面）

安装

该插件可以通过Cordova-CLI安装，并可在NPM上公开获得。

从项目根文件夹执行：

$ cordova plugin add cordova-plugin-badge

或者安装特定版本：

$ cordova plugin add cordova-plugin-badge@VERSION

或安装最新的头版：

$ cordova plugin add https://github.com/katzer/cordova-plugin-badge.git

或者从本地来源安装：

$ cordova plugin add <path> --nofetch --nosave

用法

该插件创建对象cordova.plugins.notification.badge，并在触发deviceready后可访问。

document.addEventListener('deviceready', function () {
    // cordova.plugins.notification.badge is now available
}, false);

 

设置徽章编号

徽章数量不能为负数。操作系统可能会限制最大值。回调是可选的，将使用当前的徽章编号进行调用。

 cordova.plugins.notification.badge.set(10);

 

            

有内置支持来增加徽章编号：

cordova.plugins.notification.badge.increase(1, function (badge) {
    // badge is now 11 (10 + 1)
});

 

要减少徽章编号：

cordova.plugins.notification.badge.decrease(2, function (badge) {
    // badge is now 9 (11 - 2)
});

 

并清除徽章编号：

cordova.plugins.notification.badge.clear();

 

获取徽章编号

默认值为0.重启或应用重启后，徽章编号不会丢失。

cordova.plugins.notification.badge.get(function (badge) {
    ...
});

 

注意：修改插件外部的徽章编号会导致错误的行为！

配置

如果用户点按应用图标，则自动清除徽章编号：

cordova.plugins.notification.badge.configure({ autoClear: true });

 

OSX支持其他指标。除了badge这些是circular和download。

cordova.plugins.notification.badge.configure({ indicator: 'circular' });

 

            

权限

该插件可能会要求授予修改徽章编号的权限。这是自动完成的，但也可以手动请求它们：

cordova.plugins.notification.badge.requestPermission(function (granted) {
    ...
});

 

要检查它们是否已被授予：

cordova.plugins.notification.badge.hasPermission(function (granted) {
    ...
});

 

怪癖

在Android上并非所有发射器都支持徽章。为了设置徽章，插件使用ShortcutBadger。查看他们的网站，了解支持哪些发射器。

如果您正在使用PhoneGap Build，请确保在config.xml中将gradle指定为Android构建工具：

<preference name="android-build-tool" value="gradle" />

 

要指定ShortcutBadger的自定义版本，请遵循本指南。该物业的名称是appShortcutBadgerVersion。

// In <your-project>/platforms/android/build-extras.gradle
ext.appShortcutBadgerVersion = '1.1.18'

 

特约

1. 叉吧
2. 创建您的功能分支（git checkout -b my-new-feature）
3. 提交你的更改（git commit -am 'Add some feature'）
4. 推到分支（git push origin my-new-feature）
5. 创建新的Pull请求

执照

该软件是在Apache 2.0许可下发布的。

用莱比锡的Made制成

©2013 appPlant GmbH