>

Docs for: BrowserPromptHelper

>

Events

>

OnResume

Event raised when app gets resumed and gives the url which started this activity/screen if there is any else empty string Params | []() ---------------- | ------- ```` url | text```` ____________________________________ >

Methods

>

GetStartUrl

Returns the url which started the current activity Return type : text ____________________________________ >

Docs for: CustomWebView

>

Events

>

AfterArchiveSaved

Event raised after 'SaveArchive' method.If 'success' is true then returns file path else empty string. Params | []() ---------------- | ------- ```` success | boolean```` ```` filePath | text```` ____________________________________ >

AfterJavaScriptEvaluated

Event raised after evaluating Js and returns result. Params | []() ---------------- | ------- ```` result | text```` ____________________________________ >

CookiesRemoved

Event raised after 'ClearCokies' method with result Params | []() ---------------- | ------- ```` successful | boolean```` ____________________________________ >

FileUploadNeeded

Event raised when file uploading is needed Params | []() ---------------- | ------- ```` id | number```` ```` mimeType | text```` ```` isCaptureEnabled | boolean```` ____________________________________ >

FindResultReceived

Event raised after 'Find' method with int 'activeMatchOrdinal','numberOfMatches' and 'isDoneCounting' Params | []() ---------------- | ------- ```` id | number```` ```` activeMatchOrdinal | number```` ```` numberOfMatches | number```` ```` isDoneCounting | boolean```` ____________________________________ >

GotCertificate

Event raised after getting SSL certificate of current displayed url/website with boolean 'isSecure' and Strings 'issuedBy','issuedTo' and 'validTill'.If 'isSecure' is false and other values are empty then assume that website is not secure Params | []() ---------------- | ------- ```` isSecure | boolean```` ```` issuedBy | text```` ```` issuedTo | text```` ```` validTill | text```` ____________________________________ >

GotPrintResult

Event raised after getting previus print's result. Params | []() ---------------- | ------- ```` printId | text```` ```` isCompleted | boolean```` ```` isFailed | boolean```` ```` isBlocked | boolean```` ____________________________________ >

LongClicked

Event raised when something is long clicked in webview with item(image,string,empty,etc) and type(item type like 0,1,8,etc) Params | []() ---------------- | ------- ```` id | number```` ```` item | text```` ```` secondaryUrl | text```` ```` type | number```` ____________________________________ >

OnCloseWindowRequest

Event triggered when a window needs to be closed Params | []() ---------------- | ------- ```` id | number```` ____________________________________ >

OnConsoleMessage

Event raised after getting console message. Params | []() ---------------- | ------- ```` message | text```` ```` lineNumber | number```` ```` sourceID | number```` ```` level | text```` ____________________________________ >

OnDownloadNeeded

Event raised when downloading is needed. Params | []() ---------------- | ------- ```` id | number```` ```` url | text```` ```` contentDisposition | text```` ```` mimeType | text```` ```` size | number```` ____________________________________ >

OnErrorReceived

Event raised when any error is received during loading url and returns message,error code and failing url Params | []() ---------------- | ------- ```` id | number```` ```` message | text```` ```` errorCode | number```` ```` url | text```` ____________________________________ >

OnFormResubmission

Event raised when resubmission of form is needed Params | []() ---------------- | ------- ```` id | number```` ____________________________________ >

OnGeolocationRequested

Event for OnGeolocationRequested Params | []() ---------------- | ------- ```` origin | text```` ____________________________________ >

OnHideCustomView

Event raised when current page exits from full screen mode ____________________________________ >

OnJsAlert

Event raised when Js have to show an alert to user Params | []() ---------------- | ------- ```` id | number```` ```` url | text```` ```` message | text```` ____________________________________ >

OnJsConfirm

Tells to display a confirm dialog to the user. Params | []() ---------------- | ------- ```` id | number```` ```` url | text```` ```` message | text```` ____________________________________ >

OnJsPrompt

Event raised when JavaScript needs input from user Params | []() ---------------- | ------- ```` id | number```` ```` url | text```` ```` message | text```` ```` defaultValue | text```` ____________________________________ >

OnNewWindowRequest

Event raised when new window is requested by webview with boolean 'isDialog' and 'isPopup' Params | []() ---------------- | ------- ```` id | number```` ```` isDialog | boolean```` ```` isPopup | boolean```` ____________________________________ >

OnPermissionRequest

Event raised when a website asks for specific permission(s) in list format. Params | []() ---------------- | ------- ```` permissionsList | list```` ____________________________________ >

OnProgressChanged

Event raised when page loading progress has changed. Params | []() ---------------- | ------- ```` id | number```` ```` progress | number```` ____________________________________ >

OnReceivedHttpAuthRequest

Notifies that the WebView received an HTTP authentication request. Params | []() ---------------- | ------- ```` id | number```` ```` host | text```` ```` realm | text```` ____________________________________ >

OnReceivedSslError

Event for OnReceivedSslError Params | []() ---------------- | ------- ```` errorCode | number```` ____________________________________ >

OnScrollChanged

Event raised when webview gets scrolled Params | []() ---------------- | ------- ```` id | number```` ```` scrollX | number```` ```` scrollY | number```` ```` oldScrollX | number```` ```` oldScrollY | number```` ```` canGoLeft | boolean```` ```` canGoRight | boolean```` ____________________________________ >

OnShowCustomView

Event raised when current page enters in full screen mode ____________________________________ >

PageLoaded

Event raised when page loading has finished. Params | []() ---------------- | ------- ```` id | number```` ____________________________________ >

PageStarted

Event indicating that page loading has started in web view. Params | []() ---------------- | ------- ```` id | number```` ```` url | text```` ____________________________________ >

WebViewStringChanged

When the JavaScript calls AppInventor.setWebViewString this event is run. Params | []() ---------------- | ------- ```` value | text```` ____________________________________ >

Methods

>

AllowGeolocationAccess

Method for AllowGeolocationAccess Params | []() ---------------- | ------- ```` allow | boolean````
```` remember | boolean````
____________________________________ >

CanGoBack

Gets whether this WebView has a back history item Return type : boolean ____________________________________ >

CanGoBackOrForward

Gets whether the page can go back or forward the given number of steps. Params | []() ---------------- | ------- ```` steps | number````
Return type : boolean ____________________________________ >

CanGoForward

Gets whether this WebView has a forward history item. Return type : boolean ____________________________________ >

CancelPrinting

Cancels current print job. You can request cancellation of a queued, started, blocked, or failed print job. ____________________________________ >

ClearCache

Clears the resource cache. ____________________________________ >

ClearCookies

Removes all cookies and raises 'CookiesRemoved' event ____________________________________ >

ClearInternalHistory

Tells this WebView to clear its internal back/forward list. ____________________________________ >

ClearLocation

Clear all location preferences. ____________________________________ >

ClearMatches

Clears the highlighting surrounding text matches. ____________________________________ >

ConfirmJs

Whether to proceed JavaScript originated request Params | []() ---------------- | ------- ```` confirm | boolean````
____________________________________ >

ContentHeight

Gets height of HTML content Return type : number ____________________________________ >

ContinueJs

Inputs a confirmation response to Js Params | []() ---------------- | ------- ```` input | text````
____________________________________ >

CreateShortcut

Creates a shortcut of given website on home screen Params | []() ---------------- | ------- ```` url | text````
```` iconPath | text````
```` title | text````
____________________________________ >

CreateWebView

Creates the webview in given arrangement with id Params | []() ---------------- | ------- ```` container | component````
```` id | number````
____________________________________ >

CurrentId

Returns current id Return type : number ____________________________________ >

DismissJsAlert

Dismiss previously requested Js alert ____________________________________ >

EvaluateJavaScript

Asynchronously evaluates JavaScript in the context of the currently displayed page. Params | []() ---------------- | ------- ```` script | text````
____________________________________ >

Find

Finds all instances of find on the page and highlights them, asynchronously. Successive calls to this will cancel any pending searches. Params | []() ---------------- | ------- ```` string | text````
____________________________________ >

FindNext

Highlights and scrolls to the next match if 'forward' is true else scrolls to previous match. Params | []() ---------------- | ------- ```` forward | boolean````
____________________________________ >

GetCookies

Get cookies for specific url Params | []() ---------------- | ------- ```` url | text````
Return type : text ____________________________________ >

GetIds

Returns a list of used ids Return type : list ____________________________________ >

GetInternalHistory

Get internal history of given webview. Params | []() ---------------- | ------- ```` id | number````
Return type : list ____________________________________ >

GetProgress

Gets the progress for the given webview Params | []() ---------------- | ------- ```` id | number````
Return type : number ____________________________________ >

GetScrollX

Return the scrolled left position of the webview Return type : number ____________________________________ >

GetScrollY

Return the scrolled top position of the webview Return type : number ____________________________________ >

GetSslCertificate

Gets the SSL certificate for the main top-level page and raises 'GotCertificate' event ____________________________________ >

GetWebView

Returns webview object from id Params | []() ---------------- | ------- ```` id | number````
Return type : any ____________________________________ >

GoBack

Goes back in the history of this WebView. ____________________________________ >

GoBackOrForward

Goes to the history item that is the number of steps away from the current item. Steps is negative if backward and positive if forward. Params | []() ---------------- | ------- ```` steps | number````
____________________________________ >

GoForward

Goes forward in the history of this WebView. ____________________________________ >

GoToUrl

Loads the given URL. Params | []() ---------------- | ------- ```` url | text````
____________________________________ >

GrantPermission

Grants given permissions to webview.Use empty list to deny the request. Params | []() ---------------- | ------- ```` permissions | text````
____________________________________ >

HideCustomView

Hides previously shown custom view ____________________________________ >

InvokeZoomPicker

Invokes the graphical zoom picker widget for this WebView. This will result in the zoom widget appearing on the screen to control the zoom level of this WebView.Note that it does not checks whether zoom is enabled or not. ____________________________________ >

LoadHtml

Loads the given data into this WebView using a 'data' scheme URL. Params | []() ---------------- | ------- ```` html | text````
____________________________________ >

LoadInNewWindow

Loads requested url in given webview Params | []() ---------------- | ------- ```` id | number````
____________________________________ >

LoadWithHeaders

Loads the given URL with the specified additional HTTP headers defined is list of lists. Params | []() ---------------- | ------- ```` url | text````
```` headers | list````
____________________________________ >

PageDown

Scrolls the contents of the WebView down by half the page size Params | []() ---------------- | ------- ```` bottom | boolean````
____________________________________ >

PageUp

Scrolls the contents of the WebView up by half the page size Params | []() ---------------- | ------- ```` top | boolean````
____________________________________ >

PauseWebView

Does a best-effort attempt to pause any processing that can be paused safely, such as animations and geolocation. Note that this call does not pause JavaScript. Params | []() ---------------- | ------- ```` id | number````
____________________________________ >

PostData

Loads the URL with postData using 'POST' method into active WebView. Params | []() ---------------- | ------- ```` url | text````
```` data | text````
____________________________________ >

PrintWebContent

Prints the content of webview with given document name Params | []() ---------------- | ------- ```` documentName | text````
____________________________________ >

ProceedHttpAuthRequest

Instructs the WebView to proceed with the authentication with the given credentials.If both parameters are empty then it will cancel the request. Params | []() ---------------- | ------- ```` username | text````
```` password | text````
____________________________________ >

ProceedSslError

Method for ProceedSslError Params | []() ---------------- | ------- ```` proceed | boolean````
____________________________________ >

Reload

Reloads the current URL. ____________________________________ >

RemoveWebView

Destroys the webview and removes it completely from view system Params | []() ---------------- | ------- ```` id | number````
____________________________________ >

RestartPrinting

Restarts current/previous print job. You can request restart of a failed print job. ____________________________________ >

ResubmitForm

Whether to resubmit form or not. Params | []() ---------------- | ------- ```` reSubmit | boolean````
____________________________________ >

ResumeWebView

Resumes the previously paused WebView. Params | []() ---------------- | ------- ```` id | number````
____________________________________ >

SaveArchive

Saves the current site as a web archive Params | []() ---------------- | ------- ```` dir | text````
____________________________________ >

ScrollTo

Scrolls the webview to given position Params | []() ---------------- | ------- ```` x | number````
```` y | number````
____________________________________ >

SetCookies

Sets cookies for given url Params | []() ---------------- | ------- ```` url | text````
```` cookieString | text````
____________________________________ >

SetVisibility

Sets the visibility of webview by id Params | []() ---------------- | ------- ```` id | number````
```` visibility | boolean````
____________________________________ >

SetWebView

Set specific webview to current webview by id Params | []() ---------------- | ------- ```` id | number````
____________________________________ >

StopLoading

Stops the current load. ____________________________________ >

UploadFile

Uploads the given file from content uri.Use empty string to cancel the upload request. Params | []() ---------------- | ------- ```` contentUri | text````
____________________________________ >

ZoomBy

Performs a zoom operation in the WebView by given zoom percent Params | []() ---------------- | ------- ```` zoomP | number````
____________________________________ >

ZoomIn

Performs zoom in in the WebView ____________________________________ >

ZoomOut

Performs zoom out in the WebView ____________________________________ >

Properties

>

AdHosts

Sets the ad hosts which will be blocked Property Type : write-only
Accepts : text ____________________________________ >

AutoLoadImages

Sets whether the WebView should load image resources Property Type : read-write
Accepts : boolean ____________________________________ >

Autofill

Specifies whether webview should autofill saved credentials or not Property Type : write-only
Accepts : boolean ____________________________________ >

AutoplayMedia

Sets whether the WebView requires a user gesture to play media Property Type : read-write
Accepts : boolean ____________________________________ >

BackgroundColor

Sets background color of webview Property Type : write-only
Accepts : number ____________________________________ >

BlockAds

Sets whether to block ads or not Property Type : write-only
Accepts : boolean ____________________________________ >

BlockNetworkLoads

Sets whether the WebView should not load resources from the network.Use this to save data. Property Type : read-write
Accepts : boolean ____________________________________ >

CacheMode

Sets cache mode for active webview Property Type : read-write
Accepts : number ____________________________________ >

CurrentPageTitle

Title of the page currently viewed Property Type : read-only
Accepts : text ____________________________________ >

CurrentUrl

URL of the page currently viewed Property Type : read-only
Accepts : text ____________________________________ >

DeepLinks

Sets whether to enable deep links or not i.e. tel: , whatsapp: , sms: , etc. Property Type : read-write
Accepts : boolean ____________________________________ >

DesktopMode

Sets whether to load content in desktop mode Property Type : read-write
Accepts : boolean ____________________________________ >

DisplayZoom

Sets whether the WebView should display on-screen zoom controls Property Type : read-write
Accepts : boolean ____________________________________ >

EnableJS

Tells the WebView to enable JavaScript execution. Property Type : read-write
Accepts : boolean ____________________________________ >

FileAccess

Sets whether webview can access local files.Use this to enable file uploading and loading files using HTML Property Type : read-write
Accepts : boolean ____________________________________ >

FollowLinks

Determines whether to follow links when they are tapped in the WebViewer.If you follow links, you can use GoBack and GoForward to navigate the browser history Property Type : read-write
Accepts : boolean ____________________________________ >

FontSize

Sets the default font size of text. The default is 16. Property Type : read-write
Accepts : number ____________________________________ >

InitialScale

Sets the initial scale for active WebView. 0 means default. If initial scale is greater than 0, WebView starts with this value as initial scale. Property Type : write-only
Accepts : number ____________________________________ >

LayerType

Property for LayerType Property Type : read-write
Accepts : number ____________________________________ >

LoadWithOverviewMode

Sets whether the WebView loads pages in overview mode, that is, zooms out the content to fit on screen by width. This setting is taken into account when the content width is greater than the width of the WebView control. Property Type : read-write
Accepts : boolean ____________________________________ >

LongClickable

Sets whether to enable text selection and context menu Property Type : read-write
Accepts : boolean ____________________________________ >

OverScrollMode

Property for OverScrollMode Property Type : read-write
Accepts : number ____________________________________ >

PromptForPermission

Returns whether webview will prompt for permission and raise 'OnPermissionRequest' event or not Property Type : read-write
Accepts : boolean ____________________________________ >

RotationAngle

Property for RotationAngle Property Type : read-write
Accepts : number ____________________________________ >

ScrollBar

Whether to display horizonatal and vertical scrollbars or not Property Type : write-only
Accepts : boolean ____________________________________ >

ScrollBarStyle

Property for ScrollBarStyle Property Type : read-write
Accepts : number ____________________________________ >

SupportMultipleWindows

Sets whether the WebView supports multiple windows Property Type : read-write
Accepts : boolean ____________________________________ >

UseWideViewPort

Sets whether the WebView should enable support for the 'viewport' HTML meta tag or should use a wide viewport. Property Type : read-write
Accepts : boolean ____________________________________ >

UserAgent

Get webview user agent Property Type : read-write
Accepts : text ____________________________________ >

UsesLocation

Whether or not to give the application permission to use the Javascript geolocation API Property Type : write-only
Accepts : boolean ____________________________________ >

Visible

Returns the visibility of current webview Property Type : read-only
Accepts : boolean ____________________________________ >

WebViewString

Set webview string Property Type : read-write
Accepts : text ____________________________________ >

ZoomEnabled

Sets whether the WebView should support zooming using its on-screen zoom controls and gestures Property Type : read-write
Accepts : boolean ____________________________________ >

ZoomPercent

Sets the zoom of the page in percent. The default is 100 Property Type : read-write
Accepts : number ____________________________________ >

Docs for: DownloadHelper

>

Events

>

DownloadCompleted

Event invoked when downloading gets completed ____________________________________ >

DownloadProgressChanged

Event invoked when downloading progress changes Params | []() ---------------- | ------- ```` progress | number```` ____________________________________ >

Methods

>

Cancel

Cancels the current download request ____________________________________ >

Download

Downloads the given file Params | []() ---------------- | ------- ```` url | text````
```` mimeType | text````
```` contentDisposition | text````
```` fileName | text````
```` downloadDir | text````
____________________________________ >

OpenFile

Tries to open the last downloaded file ____________________________________