Skip to main content

notify

FitFileViewer - API Documentation v29.4.0

FitFileViewer - API Documentation / utils/ui/notifications/showNotification / notify

Variable: notify

const notify: { error: (message: string, duration?: number, options?: Object) => Promise<void>; info: (message: string, duration?: number, options?: Object) => Promise<void>; persistent: (message: string, type?: string, options?: Object) => Promise<void>; success: (message: string, duration?: number, options?: Object) => Promise<void>; warning: (message: string, duration?: number, options?: Object) => Promise<void>; withActions: (message: string, type?: string, actions: NotificationAction[], options?: Object) => Promise<void>; }

Defined in: utils/ui/notifications/showNotification.js:419

Convenience methods for common notification types

Type Declaration​

error()​

error: (message: string, duration?: number, options?: Object) => Promise<void>

Shows an error notification

Parameters​

message​

string

Message to display

duration?​

number

Duration in milliseconds

options?​

Object

Additional options

Returns​

Promise<void>

info()​

info: (message: string, duration?: number, options?: Object) => Promise<void>

Shows an info notification

Parameters​

message​

string

Message to display

duration?​

number

Duration in milliseconds

options?​

Object

Additional options

Returns​

Promise<void>

persistent()​

persistent: (message: string, type?: string, options?: Object) => Promise<void>

Shows a persistent notification that requires user interaction to dismiss

Parameters​

message​

string

Message to display

type?​

string = "info"

Notification type

options?​

Object = {}

Additional options

Returns​

Promise<void>

success()​

success: (message: string, duration?: number, options?: Object) => Promise<void>

Shows a success notification

Parameters​

message​

string

Message to display

duration?​

number

Duration in milliseconds

options?​

Object

Additional options

Returns​

Promise<void>

warning()​

warning: (message: string, duration?: number, options?: Object) => Promise<void>

Shows a warning notification

Parameters​

message​

string

Message to display

duration?​

number

Duration in milliseconds

options?​

Object

Additional options

Returns​

Promise<void>

withActions()​

withActions: (message: string, type?: string, actions: NotificationAction[], options?: Object) => Promise<void>

Shows a notification with action buttons

Parameters​

message​

string

Message to display

type?​

string = "info"

Notification type

actions?​

NotificationAction[] = []

Action button definitions

options?​

Object = {}

Additional options

Returns​

Promise<void>