Skip to main content

Interface: NotificationOptions

Defined in: packages/extension-api/src/extension-api.d.ts:1780

Properties​

body?​

optional body?: string

Defined in: packages/extension-api/src/extension-api.d.ts:1788

The body text of the notification, which will be displayed below the title.

highlight?​

optional highlight?: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:1804

this notification will be highlighted to the user so it draws attention

icon?​

optional icon?: string

Defined in: packages/extension-api/src/extension-api.d.ts:1808

icon to display in the notification

iconColor?​

optional iconColor?: string

Defined in: packages/extension-api/src/extension-api.d.ts:1812

icon color for custom icon

markdownActions?​

optional markdownActions?: string

Defined in: packages/extension-api/src/extension-api.d.ts:1800

displayed below the description. It contains actions (like markdown commands/buttons and links)

silent?​

optional silent?: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:1792

Whether or not to emit an OS notification noise when showing the notification.

title?​

optional title?: string

Defined in: packages/extension-api/src/extension-api.d.ts:1784

A title for the notification, which will be shown at the top of the notification window when it is shown.

type?​

optional type?: NotificationType

Defined in: packages/extension-api/src/extension-api.d.ts:1796

The type of the notification. Default value: info