/*! * Copyright 2017 - 2020 by ChartIQ, Inc. * All rights reserved. */ export declare type ToastFrequency = "ALWAYS" | "ONCE-SINCE-STARTUP" | "MAX-COUNT"; export declare type ToastOptions = { maxCount?: number; duration?: number; }; /** * Conditionally alerts the end user using a desktop notification (toast). * * In addition to the params specified here, params may also include any valid parameter for electron.Notification. * * Set topic = "devModeOnly" so that UserNotifications only are displayed when running from the seed or with SDD. * * @param topic Specifies a category for the notification. This parameter is reserved for future use; it is designed to filter notifications (e.g., applying regEx's defined in config to determine which notifications are displayed). Any topic string can be specified; however "system" is the recommended topic for system notifications applicable both to end uses and to developers. "dev" is the recommended topic for notifications applicable only during development (e.g., a notification that config.json has an illegal value). * @param frequency Either "ALWAYS", "ONCE-SINCE-STARTUP", or "MAX-COUNT" to determine if alert should be displayed. Note, the frequencies are based on the number of notifications emitted from a window (as opposed to system wide). * @param identifier Uniquely identifies this specific notification message. Used when "frequency" is set to "ONCE-SINCE-STARTUP" or "MAX-COUNT". * @param message Message to display in the notification. Typically a string. Finsemble's built in templating accepts and object. See ../src/components/notification/notification.html. * @param params * @param params.maxCount Specifies the max number of notifications to display for specified identifier when frequency="MAX-COUNT" (default is 1). * @param params.duration Time in milliseconds before auto-dismissing the notification (defaults to 24 hours). * * @example * FSBL.UserNotification.alert("system", "ONCE-SINCE-STARTUP", "MANIFEST-Error", message); * FSBL.UserNotification.alert("dev", "ALWAYS", "Config-Error", message, { duration: 1000 * 5 }); * FSBL.UserNotification.alert("dev", "MAX-COUNT", "Transport-Failure", message, { maxCount: 2 }); */ export declare const toast: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions) => void; declare const _default: { toast: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions | undefined) => void; alert: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions | undefined) => void; }; export default _default; //# sourceMappingURL=toast.d.ts.map