Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface NotificationOptions

    interface NotificationOptions {
        clean?: boolean;
        console?: boolean;
        escape?: boolean;
        format?: Record<string, string>;
        localize?: boolean;
        permanent?: boolean;
        progress?: boolean;
    }
    Index

    Properties

    clean? console? escape? format? localize? permanent? progress?

    Properties

    clean?: boolean

    Whether to clean the provided message string as untrusted user input. No cleaning is applied if format is passed and escape is true or localize is true and format is not passed.

    console?: boolean

    Whether to log the message to the console

    escape?: boolean

    Whether to escape the values of format

    format?: Record<string, string>

    A mapping of formatting strings passed to Localization#format

    localize?: boolean

    Whether to localize the message content before displaying it

    permanent?: boolean

    Should the notification be permanently displayed until dismissed

    progress?: boolean

    Does this Notification include a progress bar?

    Settings

    Member Visibility

    On This Page

    Properties