Header menu logo fable-electron-docs-api

Options Type

Constructors

Constructor Description

Options(title, content, ?icon, ?iconType, ?largeIcon, ?noSound, ?respectQuietTime)

Full Usage: Options(title, content, ?icon, ?iconType, ?largeIcon, ?noSound, ?respectQuietTime)

Parameters:
    title : string -
    content : string -
    ?icon : U2<NativeImage, string> - Icon to use when iconType is custom.
    ?iconType : IconType - Can be none, info, warning, error or custom. Default is custom.
    ?largeIcon : bool - The large version of the icon should be used. Default is true. Maps to NIIF_LARGE_ICON.
    ?noSound : bool - Do not play the associated sound. Default is false. Maps to NIIF_NOSOUND.
    ?respectQuietTime : bool - Do not display the balloon notification if the current user is in "quiet time". Default is false. Maps to NIIF_RESPECT_QUIET_TIME.

Returns: Options
title : string

content : string

?icon : U2<NativeImage, string>

Icon to use when iconType is custom.

?iconType : IconType

Can be none, info, warning, error or custom. Default is custom.

?largeIcon : bool

The large version of the icon should be used. Default is true. Maps to NIIF_LARGE_ICON.

?noSound : bool

Do not play the associated sound. Default is false. Maps to NIIF_NOSOUND.

?respectQuietTime : bool

Do not display the balloon notification if the current user is in "quiet time". Default is false. Maps to NIIF_RESPECT_QUIET_TIME.

Returns: Options

Instance members

Instance member Description

this.content

Full Usage: this.content

this.icon

Full Usage: this.icon

Icon to use when iconType is custom.

this.iconType

Full Usage: this.iconType

Can be none, info, warning, error or custom. Default is custom.

this.largeIcon

Full Usage: this.largeIcon

The large version of the icon should be used. Default is true. Maps to NIIF_LARGE_ICON.

this.noSound

Full Usage: this.noSound

Do not play the associated sound. Default is false. Maps to NIIF_NOSOUND.

this.respectQuietTime

Full Usage: this.respectQuietTime

Do not display the balloon notification if the current user is in "quiet time". Default is false. Maps to NIIF_RESPECT_QUIET_TIME.

this.title

Full Usage: this.title

Type something to start searching.