com.tuarua.webview
WebkitSettings
Object
WebkitSettings
allowsAirPlayForMediaPlayback
A Boolean value indicating whether AirPlay is allowed.
true
A Boolean value indicating whether AirPlay is allowed.
allowsInlineMediaPlayback
A Boolean value indicating whether HTML5 videos play inline or use the native full-screen controller.
false
A Boolean value indicating whether HTML5 videos play inline or use the native full-screen controller.
allowsPictureInPictureMediaPlayback
A Boolean value indicating whether HTML5 videos can play picture-in-picture.
true
A Boolean value indicating whether HTML5 videos can play picture-in-picture.
bounces
A Boolean value indicating whether the webview bounces past edge of content and back again.
true
A Boolean value indicating whether the webview bounces past edge of content and back again.
custom
Add custom preferences via preferences.setValue.
unknown
Add custom preferences via preferences.setValue. This can be used to set private APIs. Use at own risk.
ignoresViewportScaleLimits
A Boolean value that determines whether a WKWeb​View object should always allow scaling of the webpage.
false
A Boolean value that determines whether a WKWeb​View object should always allow scaling of the webpage.
javaEnabled
A Boolean value indicating whether Java is enabled.
false
A Boolean value indicating whether Java is enabled. OSX only.
javaScriptCanOpenWindowsAutomatically
A Boolean value indicating whether JavaScript can open windows without user interaction.
true
A Boolean value indicating whether JavaScript can open windows without user interaction.
javaScriptEnabled
A Boolean value indicating whether JavaScript is enabled.
true
A Boolean value indicating whether JavaScript is enabled.
minimumFontSize
The minimum font size in points.
0
The minimum font size in points.
plugInsEnabled
A Boolean value indicating whether plug-ins are enabled.
true
A Boolean value indicating whether plug-ins are enabled. OSX only.
useZoomGestures
A Boolean value indicating whether the webview responds to pinch zoom gestures.
true
A Boolean value indicating whether the webview responds to pinch zoom gestures.
TabDetails
Object
TabDetails
index
url
title
isLoading
canGoBack
canGoForward
estimatedProgress
canGoBack
canGoForward
estimatedProgress
index
isLoading
title
url
BackForwardList
Object
BackForwardList
backList
unknown
currentItem
com.tuarua.webview:BackForwardListItem
forwardList
unknown
ContextMenu
Object
enabled
Sets whether the context menu is displayed on right click.
true
Sets whether the context menu is displayed on right click.
WebEngine
Object
DEFAULT
0
EDGE
1
JavascriptResult
Object
JavascriptResult
result
null
message
null
error
null
success
false
error
message
Reserved for future use.
Reserved for future use.
result
success
CefSettings
Object
CefSettings
acceptLanguageList
Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header.
en-US,en
Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. May be set globally using the CefSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used.
cachePath
The location where cache data will be stored on disk.
cache
The location where cache data will be stored on disk. If empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. Can be overridden for individual CefRequestContext instances via the RequestContextSettings.CachePath value.
commandLineArgs
Add custom command line arguments to this collection, they will be added in OnBeforeCommandLineProcessing.
unknown
Add custom command line arguments to this collection, they will be added in OnBeforeCommandLineProcessing.
enablePrintPreview
Set command line argument to enable Print Preview See https://bitbucket.org/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.
Set command line argument to enable Print Preview See https://bitbucket.org/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.
locale
The locale string that will be passed to WebKit.
en-US
The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used.
logSeverity
The log severity.
99
The log severity. Only messages of this severity level or higher will be logged. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "error-report" or "disable".
remoteDebuggingPort
Set to a value between 1024 and 65535 to enable remote debugging on the specified port.
8088
Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also configurable using the "remote-debugging-port" command-line switch.
userDataPath
The location where user data such as spell checking dictionary files will be stored on disk.
The location where user data such as spell checking dictionary files will be stored on disk. If empty then the default platform-specific user data directory "Local Settings\Application Data\CEF\User Data"directory under the user profile directory on Windows).
DownloadProgress
Object
DownloadProgress
bytesLoaded
Returns the number of received bytes.
0
Returns the number of received bytes.
bytesTotal
Returns the total number of bytes.
0
Returns the total number of bytes.
id
Returns the unique identifier for this download.
0
Returns the unique identifier for this download.
percent
Returns the rough percent complete or -1 if the receive total size is unknown.
0
Returns the rough percent complete or -1 if the receive total size is unknown.
speed
Returns a simple speed estimate in bytes/s.
0
Returns a simple speed estimate in bytes/s.
tab
Returns the current tab of this download.
0
Returns the current tab of this download.
url
Returns the URL as it was before any redirects.
Returns the URL as it was before any redirects.
WebViewEvent
flash.events:Event
WebViewEvent
type
params
null
bubbles
false
cancelable
false
clone
toString
ON_CONSOLE_MESSAGE
Placeholder only.
WebView.OnConsoleMessage
Placeholder only.
ON_DOWNLOAD_CANCEL
Dispatched when download is cancelled Windows + OSX only.
WebView.OnDownloadCancel
Dispatched when download is cancelled

Windows + OSX only.

ON_DOWNLOAD_COMPLETE
Dispatched when download is marked as complete Windows + OSX only.
WebView.OnDownloadComplete
Dispatched when download is marked as complete

Windows + OSX only.

ON_DOWNLOAD_PROGRESS
Dispatched when download progress changes Windows + OSX only.
WebView.OnDownloadProgress
Dispatched when download progress changes

Windows + OSX only.

ON_FAIL
WebView.OnFail
ON_PDF_PRINTED
Dispatched when the pdf is saved after printToPdf() has been called.
WebView.OnPdfPrinted
Dispatched when the pdf is saved after printToPdf() has been called.
ON_POPUP_BLOCKED
Dispatched when a pop is blocked (due to settings.popup.behaviour).
WebView.OnPopupBlocked
Dispatched when a pop is blocked (due to settings.popup.behaviour).
ON_PROPERTY_CHANGE
Dispatched when one of the following is updated url, title, isLoading, canGoBack, canGoForward, estimatedProgress, statusMessage.
WebView.OnPropertyChange
Dispatched when one of the following is updated url, title, isLoading, canGoBack, canGoForward, estimatedProgress, statusMessage. This returns an object with 2 properties: propertyName, tab
ON_URL_BLOCKED
Dispatched when a url is blocked (due to settings.urlWhiteList).
WebView.OnUrlBlocked
Dispatched when a url is blocked (due to settings.urlWhiteList).
params
BackForwardListItem
Object
BackForwardListItem
initialURL
title
url
LogSeverity
Object
LogSeverity
DEFAULT
0
DISABLE
99
ERROR
4
INFO
2
VERBOSE
1
WARNING
3
AndroidSettings
Object
AndroidSettings
allowContentAccess
Enables or disables content URL access within WebView.
true
Enables or disables content URL access within WebView.
allowFileAccessFromFileURLs
Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
true
Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
allowFileAccess
Enables or disables file access within WebView.
true
Enables or disables file access within WebView.
allowUniversalAccessFromFileURLs
Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
true
Sets whether JavaScript running in the context of a file scheme URL should be allowed to access content from other file scheme URLs.
blockNetworkImage
A Boolean value indicating whether the WebView should not load image resources from the network.
false
A Boolean value indicating whether the WebView should not load image resources from the network.
builtInZoomControls
Sets whether the WebView should use its built-in zoom mechanisms.
true
Sets whether the WebView should use its built-in zoom mechanisms.
databaseEnabled
Sets whether the database storage API is enabled.
true
Sets whether the database storage API is enabled.
displayZoomControls
Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms.
false
Sets whether the WebView should display on-screen zoom controls when using the built-in zoom mechanisms.
domStorageEnabled
Sets whether the DOM storage API is enabled.
true
Sets whether the DOM storage API is enabled.
geolocationEnabled
Sets whether Geolocation is enabled.
false
Sets whether Geolocation is enabled.
javaScriptCanOpenWindowsAutomatically
A Boolean value indicating whether JavaScript can open windows without user interaction.
true
A Boolean value indicating whether JavaScript can open windows without user interaction.
javaScriptEnabled
A Boolean value indicating whether JavaScript is enabled.
true
A Boolean value indicating whether JavaScript is enabled.
mediaPlaybackRequiresUserGesture
Sets whether the WebView requires a user gesture to play media.
true
Sets whether the WebView requires a user gesture to play media.
Settings
Object
Settings
android
Settings to use for Android version.
unknown
com.tuarua.webview:AndroidSettings
Settings to use for Android version.
cacheEnabled
Enables browser cache.
true
Enables browser cache.
cef
Settings to use for CEF (Windows) version.
unknown
com.tuarua.webview:CefSettings
Settings to use for CEF (Windows) version.
contextMenu
Sets whether a context menu will appear on right click.
unknown
com.tuarua.webview:ContextMenu
Sets whether a context menu will appear on right click. OSX and Windows only.
downloadPath
The path to automatically save downloads to.
The path to automatically save downloads to. No user dialog is shown. OSX and Windows only.
enableDownloads
Sets whether downloads will be handled by the WebView.
true
Sets whether downloads will be handled by the WebView. OSX and Windows only.
engine
The web engine to use.
0
The web engine to use.
persistRequestHeaders
Persists any headers which have been added to URLRequests across multiple requests (on the same domain).
false
Persists any headers which have been added to URLRequests across multiple requests (on the same domain).

Windows, OSX, iOS only.

popup
unknown
com.tuarua.webview.popup:Popup
urlBlackList
Vector of urls to block example .pdf,.zip - This uses a simple string match.
unknown
Vector of urls to block example .pdf,.zip - This uses a simple string match. There is no regex support.
urlWhiteList
Vector of urls to allow through, example google.com - This uses a simple string match.
unknown
Vector of urls to allow through, example google.com - This uses a simple string match. There is no regex support.
useHiDPI
true
useTransparentBackground
Sets the container Window (HWND) of the webview to be transparent.
false
Sets the container Window (HWND) of the webview to be transparent.

Important! some video cards don't support this and may cause view to be invisible - Windows 8.1+ only.

userAgent
Value that will be returned as the User-Agent HTTP header.
Value that will be returned as the User-Agent HTTP header.
webkit
Settings to use for WKWebView (OSX / iOS) version.
unknown
com.tuarua.webview:WebkitSettings
Settings to use for WKWebView (OSX / iOS) version.
ActionscriptCallback
Object
ActionscriptCallback
args
null
functionName
null
callbackName
null
args
callbackName
functionName