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