TabLike | SiteKiosk Online API

Index

Methods

back canGoBack canGoForward executeScript forward getMuted getUrl getZoom navigate navigateHome onClosed reload setMuted setZoom stop

Events

onError onPageFinished onPageStarted onUrlChanged

Methods

back

back(): void
Navigates one page back in the history, if possible.

Returns void

canGoBack

canGoBack(): boolean
Returns whether the history contains any previous pages.

Returns boolean

canGoForward

canGoForward(): boolean
Returns whether the history contains any next pages.

Returns boolean

executeScript

executeScript(script: string): void
Executes the given script.
Parameters
- script: string
  
  The script to be executed.
Returns void

forward

forward(): void
Navigates one page forward in the history, if possible.

Returns void

getMuted

getMuted(): boolean
Returns the muted state.

Returns boolean

getUrl

getUrl(): string
Returns the currently set url.

Returns string

getZoom

getZoom(): number
Returns the zoom state.

Returns number

navigate

navigate(url: string): void
Navigates to a given URL.
Parameters
- url: string
  
  The URL to be navigated to.
Returns void

navigateHome

navigateHome(): void
Navigates to the home page.

Returns void

onClosed

onClosed(callback: (() => void)): EventSubscription
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

reload(): void
Reloads the current page.

Returns void

setMuted

setMuted(muted: boolean): void
Sets the muted state.
Parameters
- muted: boolean
  
  The muted state to be set.
Returns void

setZoom

setZoom(zoom: number): void
Sets the zoom state.
Parameters
- zoom: number
  
  The zoom state to be set.
Returns void

stop

stop(): void
Stops the loading of the current page.

Returns void

Events

onError

onError(callback: ((url: string, errorCode: number, errorName: string) => void)): EventSubscription
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

onPageFinished(callback: ((newUrl: string) => void)): EventSubscription
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

onPageStarted(callback: ((newUrl: string) => void)): EventSubscription
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

onUrlChanged

onUrlChanged(callback: ((url: string) => void)): EventSubscription
Registers a callback which will be triggered when the URL has changed.
Parameters
- callback: ((url: string) => void)
  
  The callback which will be triggered when the URL has changed.
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns EventSubscription

Generated using TypeDoc