summaryrefslogtreecommitdiff
path: root/plugins/de.appplant.cordova.plugin.badge/src/browser/BadgeProxy.js
blob: 44edd023a0da849827ebef8afe5579208cef1d1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
 * Copyright (c) 2013-2015 by appPlant UG. All rights reserved.
 *
 * @APPPLANT_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apache License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://opensource.org/licenses/Apache-2.0/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPPLANT_LICENSE_HEADER_END@
 */


/**
 * Instance of the Favico.js libary.
 * @type {Favico}
 */
exports.favico = new cordova.plugins.notification.badge.Favico({
    animation: 'none'
});

/**
 * Holds the current badge number value.
 * @type {Number}
 */
exports.badgeNumber = 0;


/**
 * Clears the badge of the app icon.
 *
 * @param {Function} success
 *      Success callback
 * @param {Function} error
 *      Error callback
 */
exports.clearBadge = function (success, error) {
    exports.setBadge(success, error, [0]);
};

/**
 * Sets the badge of the app icon.
 *
 * @param {Function} success
 *      Success callback
 * @param {Function} error
 *      Error callback
 * @param {Number} badge
 *      The new badge number
 */
exports.setBadge = function (success, error, args) {
    var badge = args[0];

    exports.badgeNumber = badge;

    exports.favico.badge(badge);
    success(badge);
};

/**
 * Gets the badge of the app icon.
 *
 * @param {Function} success
 *      Success callback
 * @param {Function} error
 *      Error callback
 */
exports.getBadge = function (success, error) {
    success(exports.badgeNumber);
};

/**
 * Informs if the app has the permission to show badges.
 *
 * @param {Function} success
 *      Success callback
 * @param {Function} error
 *      Error callback
 */
exports.hasPermission = function (success, error) {
    success(true);
};

/**
 * Register permission to show badges if not already granted.
 *
 * @param {Function} success
 *      Success callback
 * @param {Function} error
 *      Error callback
 */
exports.registerPermission = function (success, error) {
    success(true);
};


cordova.commandProxy.add('Badge', exports);