dop-sdk/build/src/modules/notification.d.ts

Mini App SDK for JavaScript by VTB

import { NotificationDetailedInfo, NotificationInfo, NotificationInfoType } from '../types/notification/notification-info';
/**
 * Interfaces used to store, get and clear miniapp preferences
 */
export interface NotificationProvider {
    /**
     * This method is used to clear any notifications in the Host application
     * @param {notificationType} NotificationInfoType
     * @see {shouldClearNotifications}
     */
    shouldClearNotifications(notificationType: NotificationInfoType): Promise<string>;
    /**
     * This method is used to to update badge number for a specific notification info
     * @param {notificationInfo} NotificationInfo
     * @see {shouldUpdateBadgeNumber}
     */
    shouldUpdateBadgeNumber(notificationInfo: NotificationInfo): Promise<string>;
    /**
     * This method is used to share the notification detailed information to Host app
     * @param {notificationDetailedInfo} NotificationDetailedInfo
     * @see {shouldUpdateNotificationInfo}
     */
    shouldUpdateNotificationInfo(notificationDetailedInfo: NotificationDetailedInfo): any;
}
/** @internal */
export declare class Notification implements NotificationProvider {
    /**
     * This method is used to clear any notifications in the Host application
     * @param {notificationType} NotificationInfoType
     * @see {shouldClearNotifications}
     */
    shouldClearNotifications(notificationType: NotificationInfoType): any;
    /**
     * This method is used to to update badge number for a specific notification info
     * @param {notificationInfo} NotificationInfo
     * @see {shouldUpdateBadgeNumber}
     */
    shouldUpdateBadgeNumber(notificationInfo: NotificationInfo): any;
    /**
     * This method is used to share the notification detailed information to Host app
     * @param {notificationDetailedInfo} NotificationDetailedInfo
     * @see {shouldUpdateNotificationInfo}
     */
    shouldUpdateNotificationInfo(notificationDetailedInfo: NotificationDetailedInfo): any;
}