InAppAuthBrowser class
Constructors
-
InAppAuthBrowser({int? windowId, UnmodifiableListView<
UserScript> ? initialUserScripts})
Properties
- contextMenu ↔ ContextMenu?
-
Context menu used by the browser. It should be set before opening the browser.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
View ID used internally.
latefinalinherited
- implementation → WebViewImplementation
-
Represents the WebView native implementation to be used.
The default value is
WebViewImplementation.NATIVE
.finalinherited -
initialUserScripts
→ UnmodifiableListView<
UserScript> ? -
Initial list of user scripts to be loaded at start or end of a page loading.
finalinherited
- onExitCallback ↔ Function?
-
getter/setter pair
-
onShouldOverrideUrlLoadingCallback
↔ (Future<
NavigationActionPolicy> Function(Uri? url)?) -
getter/setter pair
- pullToRefreshController ↔ PullToRefreshController?
-
Represents the pull-to-refresh feature controller.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- webViewController ↔ InAppWebViewController
-
WebView Controller that can be used to access the
InAppWebViewController
API.latefinalinherited - windowId → int?
-
The window id of a
CreateWindowAction.windowId
.finalinherited
Methods
-
androidOnFormResubmission(
Uri? url) → Future< FormResubmissionAction?> ? -
As the host application if the browser should resend data as the requested page was a result of a POST. The default is to not resend the data.
inherited
-
androidOnGeolocationPermissionsHidePrompt(
) → void -
Notify the host application that a request for Geolocation permissions, made with a previous call to androidOnGeolocationPermissionsShowPrompt has been canceled.
Any related UI should therefore be hidden.
inherited
-
androidOnGeolocationPermissionsShowPrompt(
String origin) → Future< GeolocationPermissionShowPromptResponse?> ? -
Event that notifies the host application that web content from the specified origin is attempting to use the Geolocation API, but no permission state is currently set for that origin.
Note that for applications targeting Android N and later SDKs (API level >
Build.VERSION_CODES.M
) this method is only called for requests originating from secure origins such as https. On non-secure origins geolocation requests are automatically denied.inherited -
androidOnJsBeforeUnload(
JsBeforeUnloadRequest jsBeforeUnloadRequest) → Future< JsBeforeUnloadResponse?> ? -
Event fired when the client should display a dialog to confirm navigation away from the current page.
This is the result of the
onbeforeunload
javascript event. IfJsBeforeUnloadResponse.handledByClient
istrue
, WebView will assume that the client will handle the confirm dialog. IfJsBeforeUnloadResponse.handledByClient
isfalse
, a default value oftrue
will be returned to javascript to accept navigation away from the current page. The default behavior is to returnfalse
. Setting theJsBeforeUnloadResponse.action
toJsBeforeUnloadResponseAction.CONFIRM
will navigate away from the current page,JsBeforeUnloadResponseAction.CANCEL
will cancel the navigation.inherited -
androidOnPermissionRequest(
String origin, List< String> resources) → Future<PermissionRequestResponse?> ? -
Event fired when the WebView is requesting permission to access the specified resources and the permission currently isn't granted or denied.
inherited
-
androidOnReceivedIcon(
Uint8List icon) → void -
Event fired when there is new favicon for the current page.
inherited
-
androidOnReceivedLoginRequest(
LoginRequest loginRequest) → void -
Event fired when a request to automatically log in the user has been processed.
inherited
-
androidOnReceivedTouchIconUrl(
Uri url, bool precomposed) → void -
Event fired when there is an url for an apple-touch-icon.
inherited
-
androidOnRenderProcessGone(
RenderProcessGoneDetail detail) → void -
Event fired when the given WebView's render process has exited.
The application's implementation of this callback should only attempt to clean up the WebView.
The WebView should be removed from the view hierarchy, all references to it should be cleaned up.
inherited
-
androidOnRenderProcessResponsive(
Uri? url) → Future< WebViewRenderProcessAction?> ? -
Event called once when an unresponsive renderer currently associated with the WebView becomes responsive.
inherited
-
androidOnRenderProcessUnresponsive(
Uri? url) → Future< WebViewRenderProcessAction?> ? -
Event called when the renderer currently associated with the WebView becomes unresponsive as a result of a long running blocking task such as the execution of JavaScript.
inherited
-
androidOnSafeBrowsingHit(
Uri url, SafeBrowsingThreat? threatType) → Future< SafeBrowsingResponse?> ? -
Event fired when the WebView notifies that a loading URL has been flagged by Safe Browsing.
The default behavior is to show an interstitial to the user, with the reporting checkbox visible.
inherited
-
androidOnScaleChanged(
double oldScale, double newScale) → void -
Use onZoomScaleChanged instead.
inherited
-
androidShouldInterceptRequest(
WebResourceRequest request) → Future< WebResourceResponse?> ? -
Notify the host application of a resource request and allow the application to return the data.
If the return value is
null
, the WebView will continue to load the resource as usual. Otherwise, the return response and data will be used.inherited -
close(
) → Future< void> -
Closes the
InAppBrowser
window.inherited -
getOptions(
) → Future< InAppBrowserClassOptions?> -
Gets the current
InAppBrowser
options. Returnsnull
if it wasn't able to get them.inherited -
handleMethod(
MethodCall call) → Future -
inherited
-
hide(
) → Future< void> -
Hides the
InAppBrowser
window. Calling this has no effect if theInAppBrowser
was already hidden.inherited -
Called when a web view receives a server redirect.
inherited
-
Called when a web view asks for permission to navigate to new content after the response to the navigation request is known.
inherited
-
iosOnWebContentProcessDidTerminate(
) → void -
Invoked when the web view's web content process is terminated.
inherited
-
iosShouldAllowDeprecatedTLS(
URLAuthenticationChallenge challenge) → Future< IOSShouldAllowDeprecatedTLSAction?> ? -
Called when a web view asks whether to continue with a connection that uses a deprecated version of TLS (v1.0 and v1.1).
inherited
-
isHidden(
) → Future< bool> -
Check if the Web View of the
InAppBrowser
instance is hidden.inherited -
isOpened(
) → bool -
Returns
true
if theInAppBrowser
instance is opened, otherwisefalse
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onAjaxProgress(
AjaxRequest ajaxRequest) → Future< AjaxRequestAction?> ? -
Event fired as an
XMLHttpRequest
progress. It gives the host application a chance to abort the request.inherited -
onAjaxReadyStateChange(
AjaxRequest ajaxRequest) → Future< AjaxRequestAction?> ? -
Event fired whenever the
readyState
attribute of anXMLHttpRequest
changes. It gives the host application a chance to abort the request.inherited -
onBrowserCreated(
) → void -
Event fired when the
InAppBrowser
is created.inherited -
onCloseWindow(
) → void -
Event fired when the host application should close the given WebView and remove it from the view system if necessary.
At this point, WebCore has stopped any loading in this window and has removed any cross-scripting ability in javascript.
inherited
-
onConsoleMessage(
ConsoleMessage consoleMessage) → void -
Event fired when the
InAppBrowser
webview receives aConsoleMessage
.inherited -
onCreateWindow(
CreateWindowAction createWindowAction) → Future< bool?> ? -
Event fired when the
InAppBrowser
webview requests the host application to create a new window, for example when trying to open a link withtarget="_blank"
or whenwindow.open()
is called by JavaScript side. If the host application chooses to honor this request, it should returntrue
from this method, create a new WebView to host the window. If the host application chooses not to honor the request, it should returnfalse
from this method. The default implementation of this method does nothing and hence returnsfalse
.inherited -
onDownloadStart(
Uri url) → void -
Use onDownloadStartRequest instead
inherited
-
onDownloadStartRequest(
DownloadStartRequest downloadStartRequest) → void -
Event fired when
WebView
recognizes a downloadable file. To download the file, you can use the flutter_downloader plugin.inherited -
onEnterFullscreen(
) → void -
Event fired when the current page has entered full screen mode.
inherited
-
onExit(
) → void -
Event fired when the
InAppBrowser
window is closed. -
onExitFullscreen(
) → void -
Event fired when the current page has exited full screen mode.
inherited
-
onFindResultReceived(
int activeMatchOrdinal, int numberOfMatches, bool isDoneCounting) → void -
Event fired as find-on-page operations progress.
The listener may be notified multiple times while the operation is underway, and the
numberOfMatches
value should not be considered final unlessisDoneCounting
is true.inherited -
onJsAlert(
JsAlertRequest jsAlertRequest) → Future< JsAlertResponse?> ? -
Event fired when javascript calls the
alert()
method to display an alert dialog. IfJsAlertResponse.handledByClient
istrue
, the webview will assume that the client will handle the dialog.inherited -
onJsConfirm(
JsConfirmRequest jsConfirmRequest) → Future< JsConfirmResponse?> ? -
Event fired when javascript calls the
confirm()
method to display a confirm dialog. IfJsConfirmResponse.handledByClient
istrue
, the webview will assume that the client will handle the dialog.inherited -
onJsPrompt(
JsPromptRequest jsPromptRequest) → Future< JsPromptResponse?> ? -
Event fired when javascript calls the
prompt()
method to display a prompt dialog. IfJsPromptResponse.handledByClient
istrue
, the webview will assume that the client will handle the dialog.inherited -
onLoadError(
Uri? url, int code, String message) → void -
Event fired when the
InAppBrowser
encounters an error loading anurl
.inherited -
onLoadHttpError(
Uri? url, int statusCode, String description) → void -
Event fired when the
InAppBrowser
main page receives an HTTP error.inherited -
onLoadResource(
LoadedResource resource) → void -
Event fired when the
InAppBrowser
webview loads a resource.inherited -
onLoadResourceCustomScheme(
Uri url) → Future< CustomSchemeResponse?> ? -
Event fired when the
InAppBrowser
webview finds thecustom-scheme
while loading a resource. Here you can handle the url request and return aCustomSchemeResponse
to load a specific resource encoded tobase64
.inherited -
onLoadStart(
Uri? url) → void -
Event fired when the
InAppBrowser
starts to load anurl
.inherited -
onLoadStop(
Uri? url) → void -
Event fired when the
InAppBrowser
finishes loading anurl
.inherited -
onLongPressHitTestResult(
InAppWebViewHitTestResult hitTestResult) → void -
Event fired when an HTML element of the webview has been clicked and held.
inherited
-
onOverScrolled(
int x, int y, bool clampedX, bool clampedY) → void -
Event fired to respond to the results of an over-scroll operation.
inherited
-
onPageCommitVisible(
Uri? url) → void -
Called when the web view begins to receive web content.
inherited
-
onPrint(
Uri? url) → void -
Event fired when
window.print()
is called from JavaScript side.inherited -
onProgressChanged(
int progress) → void -
Event fired when the current
progress
(range 0-100) of loading a page is changed.inherited -
onReceivedClientCertRequest(
URLAuthenticationChallenge challenge) → Future< ClientCertResponse?> ? -
Notify the host application to handle an SSL client certificate request.
Webview stores the response in memory (for the life of the application) if
ClientCertResponseAction.PROCEED
orClientCertResponseAction.CANCEL
is called and does not call onReceivedClientCertRequest again for the same host and port pair. Note that, multiple layers in chromium network stack might be caching the responses.inherited -
onReceivedHttpAuthRequest(
URLAuthenticationChallenge challenge) → Future< HttpAuthResponse?> ? -
Event fired when the WebView received an HTTP authentication request. The default behavior is to cancel the request.
inherited
-
onReceivedServerTrustAuthRequest(
URLAuthenticationChallenge challenge) → Future< ServerTrustAuthResponse?> ? -
Event fired when the WebView need to perform server trust authentication (certificate validation).
The host application must return either
ServerTrustAuthResponse
instance withServerTrustAuthResponseAction.CANCEL
orServerTrustAuthResponseAction.PROCEED
.inherited -
onScrollChanged(
int x, int y) → void -
Event fired when the
InAppBrowser
webview scrolls.inherited -
onTitleChanged(
String? title) → void -
Event fired when a change in the document title occurred.
inherited
-
onUpdateVisitedHistory(
Uri? url, bool? androidIsReload) → void -
Event fired when the host application updates its visited links database.
This event is also fired when the navigation state of the
InAppWebView
changes through the usage of javascript History API functions (pushState()
,replaceState()
) andonpopstate
event or, also, when the javascriptwindow.location
changes without reloading the webview (for example appending or modifying an hash to the url).inherited -
onWindowBlur(
) → void -
Event fired when the JavaScript
window
object of the WebView has lost focus. This is the result of theblur
javascript event applied to thewindow
object.inherited -
onWindowFocus(
) → void -
Event fired when the JavaScript
window
object of the WebView has received focus. This is the result of thefocus
javascript event applied to thewindow
object.inherited -
onZoomScaleChanged(
double oldScale, double newScale) → void -
Event fired when the zoom scale of the WebView has changed.
inherited
-
openData(
{required String data, String mimeType = "text/html", String encoding = "utf8", Uri? baseUrl, Uri? androidHistoryUrl, InAppBrowserClassOptions? options}) → Future< void> -
Opens the
InAppBrowser
instance withdata
as a content, usingbaseUrl
as the base URL for it.inherited -
openFile(
{required String assetFilePath, InAppBrowserClassOptions? options}) → Future< void> -
Opens the
InAppBrowser
instance with the givenassetFilePath
file.inherited -
openUrlRequest(
{required URLRequest urlRequest, InAppBrowserClassOptions? options}) → Future< void> -
Opens the
InAppBrowser
instance with anurlRequest
.inherited -
setOnExitCallback(
Function cb) → void -
setOnShouldOverrideUrlLoadingCallback(
Future< NavigationActionPolicy> cb(Uri? url)) → void -
setOptions(
{required InAppBrowserClassOptions options}) → Future< void> -
Sets the
InAppBrowser
options with the newoptions
and evaluates them.inherited -
shouldInterceptAjaxRequest(
AjaxRequest ajaxRequest) → Future< AjaxRequest?> ? -
Event fired when an
XMLHttpRequest
is sent to a server. It gives the host application a chance to take control over the request before sending it.inherited -
shouldInterceptFetchRequest(
FetchRequest fetchRequest) → Future< FetchRequest?> ? -
Event fired when a request is sent to a server through Fetch API.
It gives the host application a chance to take control over the request before sending it.
inherited
-
shouldOverrideUrlLoading(
→ Future< )NavigationActionPolicy> - Give the host application a chance to take control when a URL is about to be loaded in the current WebView. This event is not called on the initial load of the WebView.
-
show(
) → Future< void> -
Displays an
InAppBrowser
window that was opened hidden. Calling this has no effect if theInAppBrowser
was already visible.inherited -
throwIfAlreadyOpened(
{String message = ''}) → void -
inherited
-
throwIfNotOpened(
{String message = ''}) → void -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited