@capawesome/capacitor-badge/dist/esm/definitions.d.ts

Capacitor plugin to access and update the badge number of the app icon.

import type { PermissionState } from '@capacitor/core';
declare module '@capacitor/cli' {
    interface PluginsConfig {
        /**
         * These configuration values are available:
         */
        Badge?: {
            /**
             * Configure whether the plugin should restore the counter after a reboot or app restart.
             *
             * Only available on Android and iOS.
             *
             * @default true
             * @example true
             */
            persist?: boolean;
            /**
             * Configure whether the plugin should reset the counter after resuming the application.
             *
             * Only available on Android and iOS.
             *
             * @default false
             * @example false
             */
            autoClear?: boolean;
        };
    }
}
export interface BadgePlugin {
    /**
     * Get the badge count.
     * The badge count won't be lost after a reboot or app restart.
     *
     * Default: `0`.
     */
    get(): Promise<GetBadgeResult>;
    /**
     * Set the badge count.
     */
    set(options: SetBadgeOptions): Promise<void>;
    /**
     * Increase the badge count.
     */
    increase(): Promise<void>;
    /**
     * Decrease the badge count.
     */
    decrease(): Promise<void>;
    /**
     * Clear the badge count.
     */
    clear(): Promise<void>;
    /**
     * Check if the badge count is supported.
     */
    isSupported(): Promise<IsSupportedResult>;
    /**
     * Check permission to display badge.
     */
    checkPermissions(): Promise<PermissionStatus>;
    /**
     * Request permission to display badge.
     */
    requestPermissions(): Promise<PermissionStatus>;
}
export interface GetBadgeResult {
    count: number;
}
export interface SetBadgeOptions {
    count: number;
}
export interface IsSupportedResult {
    isSupported: boolean;
}
export interface PermissionStatus {
    /**
     * Permission state of displaying the badge.
     */
    display: PermissionState;
}