Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IStatus

Status

Hierarchy

  • IStatus

Index

Methods

Methods

addStatus

  • addStatus(title: string, html?: string, prepend?: boolean): PromiseLike<string>

  • Adds a status message to the page.

    Parameters

    • title: string

      The title of the status message.

    • Optional html: string

      The contents of the status message.

    • Optional prepend: boolean

      Specifies whether the status message will appear at the beginning of the list.

    Returns PromiseLike<string>

appendStatus

  • appendStatus(id: string, title: string, html: string): PromiseLike<string>

  • Appends text to an existing status message.

    Parameters

    • id: string

      The ID of the status message to remove.

    • title: string

      The title of the status message.

    • html: string

      The contents of the status message.

    Returns PromiseLike<string>

load

  • load(): PromiseLike<void>

  • Method to ensure the core script is loaded

    Returns PromiseLike<void>

removeAllStatus

  • removeAllStatus(hide?: boolean): any

  • Removes all status messages from the page.

    Parameters

    • Optional hide: boolean

      Specifies that the status messages should be hidden.

    Returns any

removeStatus

  • removeStatus(id: string): any

  • Removes the specified status message.

    Parameters

    • id: string

      The ID of the status message to remove.

    Returns any

setStatusPriColor

  • setStatusPriColor(id: string, color: string): any

  • Sets the priority color of the specified status message.

    Parameters

    • id: string

      The ID of the status message to remove.

    • color: string

      The color to set for the status message. The following table lists the values and their priority.

    Returns any

updateStatus

  • updateStatus(id: string, html: string): any

  • Updates the specified status message.

    Parameters

    • id: string

      The ID of the status message to remove.

    • html: string

      The contents of the status message.

    Returns any

Generated using TypeDoc