Options
All
  • Public
  • Public/Protected
  • All
Menu

Notify

Hierarchy

  • INotify

Index

Methods

addNotification

  • addNotification(html: string, sticky?: boolean): PromiseLike<string>
  • Adds a notification to the page. By default, notifications appear for five seconds.

    Parameters

    • html: string

      The message inside the notification.

    • Optional sticky: boolean

      Specifies whether the notification stays on the page until removed.

    Returns PromiseLike<string>

    A promise containing the ID of the notification that was added to the page.

load

  • load(): PromiseLike<void>
  • Method to ensure the core script is loaded

    Returns PromiseLike<void>

removeNotification

  • removeNotification(id: string): any
  • Removes the specified notification from the page.

    Parameters

    • id: string

      The notification to remove from the page.

    Returns any

Generated using TypeDoc