Methods

activate back canGoBack canGoForward close executeScript forward getIsActive getMuted getZoom navigate navigateHome onClosed reload setMuted setZoom stop

Events

onError onPageFinished onPageStarted

Methods

activate

  • Activates the window.

    Returns void

back

  • Navigates one page back in the history, if possible.

    Returns void

canGoBack

  • Returns whether the history contains any previous pages.

    Returns boolean

canGoForward

  • Returns whether the history contains any next pages.

    Returns boolean

close

  • Closes the tab.

    Returns void

executeScript

  • Executes the given script.

    Parameters

    • script: string

      The script to be executed.

    Returns void

forward

  • Navigates one page forward in the history, if possible.

    Returns void

getIsActive

  • Returns whether the tab is active.

    Returns boolean

getMuted

  • Returns the muted state.

    Returns boolean

getZoom

  • Returns the zoom state.

    Returns number

navigate

  • Navigates to a given URL.

    Parameters

    • url: string

      The URL to be navigated to.

    Returns void

navigateHome

  • Navigates to the home page.

    Returns void

onClosed

  • Subscribes the closed event of this object, which will be fired when this has been closed,

    Parameters

    • callback: (() => void)

      The callback which will be invoked when this has been closed.

        • (): void

        • Returns void

    Returns EventSubscription

reload

  • Reloads the current page.

    Returns void

setMuted

  • Sets the muted state.

    Parameters

    • muted: boolean

      The muted state to be set.

    Returns void

setZoom

  • Sets the zoom state.

    Parameters

    • zoom: number

      The zoom state to be set.

    Returns void

stop

  • Stops the loading of the current page.

    Returns void

Events

onError

  • Registers a callback which will be triggered when the page load results in an error.

    Parameters

    • callback: ((url: string, errorCode: number, errorName: string) => void)

      The callback which will be triggered when the page load results in an error.

        • (url: string, errorCode: number, errorName: string): void

        • Parameters

          • url: string
          • errorCode: number
          • errorName: string

          Returns void

    Returns EventSubscription

onPageFinished

  • Registers a callback which will be triggered when a page has completed loading.

    Parameters

    • callback: ((newUrl: string) => void)

      The callback which will be triggered when a page has completed loaded.

        • (newUrl: string): void

        • Parameters

          • newUrl: string

          Returns void

    Returns EventSubscription

onPageStarted

  • Registers a callback which will be triggered when a new page is being loaded.

    Parameters

    • callback: ((newUrl: string) => void)

      The callback which will be triggered when a new page is being loaded.

        • (newUrl: string): void

        • Parameters

          • newUrl: string

          Returns void

    Returns EventSubscription

Generated using TypeDoc