ElectronNotificationConstructorOptions
Unofficial
Options for constructing an ElectronNotification.
Import:
import type { ElectronNotificationConstructorOptions } from '@obsidian-typings/obsidian-catalyst-latest';Signature:
export interface ElectronNotificationConstructorOptionsProperties
| Property | Type | Description | |
|---|---|---|---|
| actions? | ElectronNotificationAction[] | Actions to add to the notification. Please read the available actions and limitations in the ElectronNotificationAction documentation. darwin only. | |
| body? | string | The body text of the notification, which will be displayed below the title or subtitle. | |
| closeButtonText? | string | A custom title for the close button of an alert. An empty string will cause the default localized text to be used. darwin only. | |
| hasReply? | boolean | Whether or not to add an inline reply option to the notification. darwin only. | |
| icon? | ElectronNativeImage | string | An icon to use in the notification. | |
| replyPlaceholder? | string | The placeholder to write in the inline reply input field. darwin only. | |
| silent? | boolean | Whether or not to emit an OS notification noise when showing the notification. | |
| sound? | string | The name of the sound file to play when the notification is shown. darwin only. | |
| subtitle? | string | A subtitle for the notification, which will be displayed below the title. darwin only. | |
| timeoutType? | 'default' | 'never' | The timeout duration of the notification. Can be default or never. linux and win32 only. | |
| title? | string | A title for the notification, which will be shown at the top of the notification window when it is shown. | |
| toastXml? | string | A custom description of the notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification. win32 only. | |
| urgency? | 'critical' | 'low' | 'normal' | The urgency level of the notification. Can be normal, critical, or low. linux only. |