Plants vs. Zombies: Replanted - v1.0.3
    Preparing search index...

    Interface INotification

    a notification message

    INotification

    interface INotification {
        actions?: INotificationAction[];
        allowSuppress?: boolean;
        createdTime?: number;
        displayMS?: number;
        group?: string;
        icon?: string;
        id?: string;
        localize?: { message?: boolean; title?: boolean };
        message: string;
        noDismiss?: boolean;
        noToast?: boolean;
        process?: string;
        progress?: number;
        replace?: { [key: string]: any };
        title?: string;
        type: NotificationType;
        updatedTime?: number;
    }
    Index

    Properties

    actions? allowSuppress? createdTime? displayMS? group? icon? id? localize? message noDismiss? noToast? process? progress? replace? title? type updatedTime?

    Properties

    actions?: INotificationAction[]

    actions to offer with the notification. These will be presented as buttons. Due to limited space you should not have more than one or two actions and usually combining actions with displayMS is probably a bad idea as it would require the user to act in a limited time.

    INotification

    allowSuppress?: boolean

    if set, the user may suppress the notification in the future

    createdTime?: number

    time the notification was created

    displayMS?: number

    the duration to display the message. If this is undefined, the message has to be dismissed by the user. Giving a duration may be convenient for the user but it is impossible to correctly estimate the time it takes a user to read a message. Please take into consideration that a user may be forced to read the message in a language not native to him and in general some people simply read slower than others. Also you can't assume the user starts reading the message immediately when it gets displayed, he may be presented with multiple messages at once. The ui may not even be visible at the time the message gets shown.

    Therefore: Absolutely never display an important message with a timer!

    As of Vortex 1.16.x, any notification with a timer will be raised as a toast notification (unless noToast is set)

    INotification

    group?: string

    if set, notifications with the same group will be grouped together and shown as one entry that can be expanded.

    icon?: string

    path to an icon/image to display in the notification. 'global' notifications displayed outside the window will always display an icon so the user can tell which application it is from. If no icon is specified this will fall back to the application icon.

    INotification

    id?: string

    unique id of the notification. can be left out as the notification system generates its own. Manually set an id if you intend to programatically stop the notification

    INotification

    localize?: { message?: boolean; title?: boolean }

    control which part of the notification gets localized. default is true for both

    message: string

    the message to display. This shouldn't be long

    INotification

    noDismiss?: boolean

    if set, no Dismiss button is provided automatically

    noToast?: boolean

    if set, the notification will not be shown as a toast even if it has a displayMS

    process?: string

    id of the process that triggered this action

    progress?: number

    progress in percent (0-100). If set, the notification is a progress indicator

    replace?: { [key: string]: any }

    replacement parameters for the localisation of title and message (the same replacement dictionary will be used for both)

    title?: string

    optional title. Should only be one or two words

    INotification

    type: NotificationType

    the kind of notification to display. This mostly determines its look but also features to a degree. Possible values:

    • 'activity': a notification that represents an activity. will have a spinner icon. Otherwise it looks like an info notification
    • 'global': This notification will always be visible, so if the window doesn't have the focus, this will be displayed as a native system notification. These notifications can not be programatically dismissed and actions are not supported
    • 'success': notification about a successful operation (ideally the user should be aware of the operation)
    • 'info': neutral information notification
    • 'error': Error notification (something went wrong)

    INotification

    updatedTime?: number

    time the notification was last updated

    Settings

    Member Visibility

    On This Page

    Properties