Class AWebView

autoInjectJSBridge

builtInZoomControls

cacheMode

databaseStorage

debugMode

displayZoomControls

domStorage

injectBridge

injectPolyfills

nestedScrollView

scrollBarIndicatorVisible

scrollBounce

src

supportPopups

ReadonlysupportXLocalScheme

supportZoom

viewPortSize

webConsoleEnabled

StaticisFetchSupported

StaticisPromiseSupported

Static ReadonlysupportXLocalScheme

AbstractcanGoBack

• get canGoBack(): boolean

  Gets a value indicating whether the WebView can navigate back.

  Returns boolean

AbstractcanGoForward

• get canGoForward(): boolean

  Gets a value indicating whether the WebView can navigate forward.

  Returns boolean

interceptScheme

• get interceptScheme(): string

  Returns string

StaticenterFullscreenEvent

• get enterFullscreenEvent(): EventNames

  Returns EventNames

StaticexitFullscreenEvent

• get exitFullscreenEvent(): EventNames

  Returns EventNames

StaticloadFinishedEvent

• get loadFinishedEvent(): EventNames

  String value used when hooking to loadFinished event.

  Returns EventNames

StaticloadProgressEvent

• get loadProgressEvent(): EventNames

  Returns EventNames

StaticloadStartedEvent

• get loadStartedEvent(): EventNames

  String value used when hooking to loadStarted event.

  Returns EventNames

StaticrequestPermissionsEvent

• get requestPermissionsEvent(): EventNames

  Returns EventNames

StaticshouldOverrideUrlLoadingEvent

• get shouldOverrideUrlLoadingEvent(): EventNames

  String value used when hooking to shouldOverrideUrlLoading event

  Returns EventNames

StatictitleChangedEvent

• get titleChangedEvent(): EventNames

  Returns EventNames

StaticwebAlertEvent

• get webAlertEvent(): EventNames

  Returns EventNames

StaticwebConfirmEvent

• get webConfirmEvent(): EventNames

  Returns EventNames

StaticwebConsoleEvent

• get webConsoleEvent(): EventNames

  Returns EventNames

StaticwebPromptEvent

• get webPromptEvent(): EventNames

  Returns EventNames

Abstract_loadData

• _loadData(src: string): void

  Platform specific loadData-implementation.

  Parameters

  • src: string

  Returns void

_loadProgress

• _loadProgress(progress: number): void

  Parameters

  • progress: number

  Returns void

Abstract_loadUrl

• _loadUrl(src: string): void

  Platform specific loadURL-implementation.

  Parameters

  • src: string

  Returns void

_onEnterFullscreen

• _onEnterFullscreen(exitFullscreen: () => void): boolean

  Parameters

  • exitFullscreen: () => void

  Returns boolean

_onExitFullscreen

• _onExitFullscreen(): boolean

  Returns boolean

_onLoadFinished

• _onLoadFinished(url: string, error?: string): Promise<LoadFinishedEventData>

  Callback for the loadFinished-event. Called from the native-webview

  Parameters

  • url: string
  • Optionalerror: string

  Returns Promise<LoadFinishedEventData>

_onLoadStarted

• _onLoadStarted(url: string, navigationType?: NavigationType): void

  Callback for onLoadStarted-event from the native webview

  Parameters

  • url: string

    URL being loaded

  • OptionalnavigationType: NavigationType

    Type of navigation (iOS-only)

  Returns void

_onRequestPermissions

• _onRequestPermissions(permissions: any): Promise<false | void>

  Parameters

  • permissions: any

  Returns Promise<false | void>

_onShouldOverrideUrlLoading

• _onShouldOverrideUrlLoading(
      url: string,
      httpMethod: string,
      navigationType?: NavigationType,
  ): boolean

  Callback for should override url loading. Called from the native-webview

  Parameters

  • url: string
  • httpMethod: string

    GET, POST etc

  • OptionalnavigationType: NavigationType

    Type of navigation (iOS-only)

  Returns boolean

_titleChanged

• _titleChanged(title: string): void

  Parameters

  • title: string

  Returns void

_webAlert

• _webAlert(message: string, callback: () => void): boolean

  Parameters

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

  Returns boolean

_webConfirm

• _webConfirm(message: string, callback: (response: boolean) => void): boolean

  Parameters

  • message: string
  • callback: (response: boolean) => void

  Returns boolean

_webConsole

• _webConsole(message: string, lineNo: number, level: string): boolean

  Parameters

  • message: string
  • lineNo: number
  • level: string

  Returns boolean

_webPrompt

• _webPrompt(
      message: string,
      defaultText: string,
      callback: (response: string) => void,
  ): boolean

  Parameters

  • message: string
  • defaultText: string
  • callback: (response: string) => void

  Returns boolean

autoExecuteJavaScript

• autoExecuteJavaScript(scriptCode: string, name: string): void

  Parameters

  • scriptCode: string
  • name: string

  Returns void

autoLoadJavaScriptFile

• autoLoadJavaScriptFile(resourceName: string, filepath: string): void

  Auto-load a JavaScript-file after the page have been loaded.

  Parameters

  • resourceName: string
  • filepath: string

  Returns void

autoLoadStyleSheetFile

• autoLoadStyleSheetFile(
      resourceName: string,
      filepath: string,
      insertBefore?: boolean,
  ): void

  Auto-load a stylesheet-file after the page have been loaded.

  Parameters

  • resourceName: string
  • filepath: string
  • OptionalinsertBefore: boolean

  Returns void

emitToWebView

• emitToWebView(eventName: string, data: any): void

  Emit event into the webview.

  Parameters

  • eventName: string
  • data: any

  Returns void

AbstractexecuteJavaScript

• executeJavaScript<T>(scriptCode: string, stringifyResult?: boolean): Promise<T>

  Execute JavaScript inside the webview. The code should be wrapped inside an anonymous-function. Larger scripts should be injected with loadJavaScriptFile. NOTE: stringifyResult only applies on iOS.

  Type Parameters

  • T

  Parameters

  • scriptCode: string
  • OptionalstringifyResult: boolean

  Returns Promise<T>

executePromise

• executePromise<T>(scriptCode: string, timeout?: number): Promise<T>

  Execute a promise inside the webview and wait for it to resolve. Note: The scriptCode must return a promise.

  Type Parameters

  • T

  Parameters

  • scriptCode: string
  • Optionaltimeout: number

  Returns Promise<T>

executePromises

• executePromises<T>(scriptCodes: string[], timeout?: number): Promise<void | T>

  Type Parameters

  • T

  Parameters

  • scriptCodes: string[]
  • Optionaltimeout: number

  Returns Promise<void | T>

fixLocalResourceName

• fixLocalResourceName(resourceName: string): string

  Helper function, strips 'x-local://' from a resource name

  Parameters

  • resourceName: string

  Returns string

generateLoadCSSFileScriptCode

• generateLoadCSSFileScriptCode(
      resourceName: string,
      path: string,
      insertBefore?: boolean,
  ): Promise<string>

  Generate script code for loading CSS-file.generateLoadCSSFileScriptCode

  Parameters

  • resourceName: string
  • path: string
  • OptionalinsertBefore: boolean

  Returns Promise<string>

generateLoadJavaScriptFileScriptCode

• generateLoadJavaScriptFileScriptCode(
      resourceName: string,
      path: string,
  ): Promise<string>

  Generate script code for loading javascript-file.

  Parameters

  • resourceName: string
  • path: string

  Returns Promise<string>

generateViewPortCode

• generateViewPortCode(): Promise<string>

  Returns Promise<string>

AbstractgetRegisteredLocalResource

• getRegisteredLocalResource(name: string): string | void

  Resolve a "x-local://{name}" to file-path.

  Parameters

  • name: string

  Returns string | void

AbstractgetTitle

• getTitle(): Promise<string | void>

  Get document.title NOTE: On Android, if empty returns filename

  Returns Promise<string | void>

AbstractgoBack

• goBack(): any

  Navigates back.

  Returns any

AbstractgoForward

• goForward(): any

  Navigates forward.

  Returns any

loadJavaScriptFile

• loadJavaScriptFile(scriptName: string, filepath: string): Promise<void>

  Load a JavaScript file on the current page in the webview.

  Parameters

  • scriptName: string
  • filepath: string

  Returns Promise<void>

loadJavaScriptFiles

• loadJavaScriptFiles(files: LoadStyleSheetResource[]): Promise<void>

  Load multiple JavaScript-files on the current page in the webview.

  Parameters

  • files: LoadStyleSheetResource[]

  Returns Promise<void>

loadStyleSheetFile

• loadStyleSheetFile(
      stylesheetName: string,
      filepath: string,
      insertBefore?: boolean,
  ): Promise<void>

  Load a stylesheet file on the current page in the webview.

  Parameters

  • stylesheetName: string
  • filepath: string
  • OptionalinsertBefore: boolean

  Returns Promise<void>

loadStyleSheetFiles

• loadStyleSheetFiles(files: LoadStyleSheetResource[]): Promise<void>

  Load multiple stylesheet-files on the current page in the webview

  Parameters

  • files: LoadStyleSheetResource[]

  Returns Promise<void>

loadUrl

• loadUrl(src: string): Promise<LoadFinishedEventData>

  Load URL - Wait for promise

  Parameters

  • src: string

  Returns Promise<LoadFinishedEventData>

on

• on(
      eventNames: string,
      callback: (data: WebViewEventData) => void,
      thisArg?: any,
  ): any

  A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

  Parameters

  • eventNames: string

    String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change").

  • callback: (data: WebViewEventData) => void

    Callback function which will be executed when event is raised.

  • OptionalthisArg: any

    An optional parameter which will be used as this context for callback execution.

  Returns any

• on(
      event: ShouldOverrideUrlLoading,
      callback: (args: ShouldOverrideUrlLoadEventData) => void,
      thisArg?: any,
  ): any

  Raised before the webview requests an URL. Can be cancelled by settings args.cancel = true in your event handler.

  Parameters

  • event: ShouldOverrideUrlLoading
  • callback: (args: ShouldOverrideUrlLoadEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: LoadStarted,
      callback: (args: LoadStartedEventData) => void,
      thisArg?: any,
  ): any

  Raised when a loadStarted event occurs.

  Parameters

  • event: LoadStarted
  • callback: (args: LoadStartedEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: LoadFinished,
      callback: (args: LoadFinishedEventData) => void,
      thisArg?: any,
  ): any

  Raised when a loadFinished event occurs.

  Parameters

  • event: LoadFinished
  • callback: (args: LoadFinishedEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: LoadProgress,
      callback: (args: LoadProgressEventData) => void,
      thisArg?: any,
  ): any

  Raised when a loadProgress event occurs.

  Parameters

  • event: LoadProgress
  • callback: (args: LoadProgressEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: TitleChanged,
      callback: (args: TitleChangedEventData) => void,
      thisArg?: any,
  ): any

  Raised when a titleChanged event occurs.

  Parameters

  • event: TitleChanged
  • callback: (args: TitleChangedEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: WebAlert,
      callback: (args: WebAlertEventData) => void,
      thisArg?: any,
  ): any

  Override web alerts to replace them. Call args.cancel() on close.

  Parameters

  • event: WebAlert
  • callback: (args: WebAlertEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: WebConfirm,
      callback: (args: WebConfirmEventData) => void,
      thisArg?: any,
  ): any

  Override web confirm dialogs to replace them. Call args.cancel(res) on close.

  Parameters

  • event: WebConfirm
  • callback: (args: WebConfirmEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: WebPrompt,
      callback: (args: WebPromptEventData) => void,
      thisArg?: any,
  ): any

  Override web confirm prompts to replace them. Call args.cancel(res) on close.

  Parameters

  • event: WebPrompt
  • callback: (args: WebPromptEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: WebConsole,
      callback: (args: WebConsoleEventData) => void,
      thisArg?: any,
  ): any

  Get Android WebView console entries.

  Parameters

  • event: WebConsole
  • callback: (args: WebConsoleEventData) => void
  • OptionalthisArg: any

  Returns any

• on(
      event: RequestPermissions,
      callback: (args: WebConsoleEventData) => void,
      thisArg?: any,
  ): any

  Get Android WebView console entries.

  Parameters

  • event: RequestPermissions
  • callback: (args: WebConsoleEventData) => void
  • OptionalthisArg: any

  Returns any

once

• once(
      eventNames: string,
      callback: (data: WebViewEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • eventNames: string
  • callback: (data: WebViewEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: ShouldOverrideUrlLoading,
      callback: (args: ShouldOverrideUrlLoadEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: ShouldOverrideUrlLoading
  • callback: (args: ShouldOverrideUrlLoadEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: LoadStarted,
      callback: (args: LoadStartedEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: LoadStarted
  • callback: (args: LoadStartedEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: LoadFinished,
      callback: (args: LoadFinishedEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: LoadFinished
  • callback: (args: LoadFinishedEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: LoadProgress,
      callback: (args: LoadProgressEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: LoadProgress
  • callback: (args: LoadProgressEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: TitleChanged,
      callback: (args: TitleChangedEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: TitleChanged
  • callback: (args: TitleChangedEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: WebAlert,
      callback: (args: WebAlertEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: WebAlert
  • callback: (args: WebAlertEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: WebConfirm,
      callback: (args: WebConfirmEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: WebConfirm
  • callback: (args: WebConfirmEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: WebPrompt,
      callback: (args: WebPromptEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: WebPrompt
  • callback: (args: WebPromptEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: WebConsole,
      callback: (args: WebConsoleEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: WebConsole
  • callback: (args: WebConsoleEventData) => void
  • OptionalthisArg: any

  Returns any

• once(
      event: RequestPermissions,
      callback: (args: WebConsoleEventData) => void,
      thisArg?: any,
  ): any

  Parameters

  • event: RequestPermissions
  • callback: (args: WebConsoleEventData) => void
  • OptionalthisArg: any

  Returns any

onWebViewEvent

• onWebViewEvent(eventName: string, data: any): void

  Called from delegate on webview event. Triggered by: window.nsWebViewBridge.emit(eventName: string, data: any); inside the webview

  Parameters

  • eventName: string
  • data: any

  Returns void

AbstractregisterLocalResource

• registerLocalResource(name: string, filepath: string): void

  Register a local resource. This resource can be loaded via "x-local://{name}" inside the webview

  Parameters

  • name: string
  • filepath: string

  Returns void

Abstractreload

• reload(): any

  Reloads the current url.

  Returns any

removeAutoExecuteJavaScript

• removeAutoExecuteJavaScript(name: string): void

  Parameters

  • name: string

  Returns void

removeAutoLoadJavaScriptFile

• removeAutoLoadJavaScriptFile(resourceName: string): void

  Parameters

  • resourceName: string

  Returns void

removeAutoLoadStyleSheetFile

• removeAutoLoadStyleSheetFile(resourceName: string): void

  Parameters

  • resourceName: string

  Returns void

resolveLocalResourceFilePath

• resolveLocalResourceFilePath(filepath: string): string | void

  Parameters

  • filepath: string

  Returns string | void

AbstractstopLoading

• stopLoading(): any

  Stops loading the current content (if any).

  Returns any

AbstractunregisterLocalResource

• unregisterLocalResource(name: string): void

  Unregister a local resource.

  Parameters

  • name: string

  Returns void

writeTrace

• writeTrace(message: string, type?: number): void

  Parameters

  • message: string
  • Optionaltype: number

  Returns void

AbstractzoomBy

• zoomBy(zoomFactor: number): any

  Parameters

  • zoomFactor: number

  Returns any

AbstractzoomIn

• zoomIn(): boolean

  Returns boolean

AbstractzoomOut

• zoomOut(): boolean

  Returns boolean