flutter_inappwebview library

Classes

AjaxRequest
Class that represents a JavaScript XMLHttpRequest object.
AjaxRequestAction
Class used by AjaxRequest class.
AjaxRequestEvent
Class used by AjaxRequest class. It represents events measuring progress of an AjaxRequest.
AjaxRequestEventType
Class used by AjaxRequestEvent class.
AjaxRequestHeaders
Class that represents the HTTP headers of an AjaxRequest.
AjaxRequestReadyState
Class used by AjaxRequest class. It represents the state of an AjaxRequest.
AndroidActionModeMenuItem
An Android-specific class used to disable the action mode menu items.
AndroidCacheMode
An Android-specific class used to override the way the cache is used.
AndroidChromeCustomTabsOptions
This class represents all the Android-only ChromeSafariBrowser options available.
AndroidForceDark
An Android-specific class used to indicate the force dark mode.
AndroidInAppBrowserOptions
This class represents all the Android-only InAppBrowser options available.
AndroidInAppWebViewController
Class represents the Android controller that contains only android-specific methods for the WebView.
AndroidInAppWebViewOptions
This class represents all the Android-only WebView options available.
AndroidLayoutAlgorithm
An Android-specific class used to set the underlying layout algorithm.
AndroidLayoutInDisplayCutoutMode
Android-specific class representing the share state that should be applied to the custom tab.
AndroidMixedContentMode
An Android-specific class used to configure the WebView's behavior when a secure origin attempts to load a resource from an insecure origin.
AndroidOptions
AndroidOverScrollMode
An Android-specific class used to configure the WebView's over-scroll mode. Setting the over-scroll mode of a WebView will have an effect only if the WebView is capable of scrolling.
AndroidPullToRefreshSize
Android-specific class representing the size of the refresh indicator.
AndroidScrollBarStyle
An Android-specific class used to configure the style of the scrollbars. The scrollbars can be overlaid or inset. When inset, they add to the padding of the view. And the scrollbars can be drawn inside the padding area or on the edge of the view. For example, if a view has a background drawable and you want to draw the scrollbars inside the padding specified by the drawable, you can use AndroidScrollBarStyle.SCROLLBARS_INSIDE_OVERLAY or AndroidScrollBarStyle.SCROLLBARS_INSIDE_INSET. If you want them to appear at the edge of the view, ignoring the padding, then you can use AndroidScrollBarStyle.SCROLLBARS_OUTSIDE_OVERLAY or AndroidScrollBarStyle.SCROLLBARS_OUTSIDE_INSET.
AndroidServiceWorkerClient
Class that represents an Android-specific class for clients to capture Service Worker related callbacks.
AndroidServiceWorkerController
Class that represents an Android-specific class that manages Service Workers used by WebView.
AndroidSslError
Class that represents the Android-specific primary error associated to the server SSL certificate. Used by the ServerTrustChallenge class.
AndroidVerticalScrollbarPosition
An Android-specific class used to configure the position of the vertical scroll bar.
AndroidWebStorageManager
Class that is used to manage the JavaScript storage APIs provided by the WebView. It manages the Application Cache API, the Web SQL Database API and the HTML5 Web Storage API.
AndroidWebStorageOrigin
Class that encapsulates information about the amount of storage currently used by an origin for the JavaScript storage APIs. An origin comprises the host, scheme and port of a URI. See AndroidWebStorageManager for details.
AndroidWebViewFeature
Class that represents an Android-specific utility class for checking which WebView Support Library features are supported on the device.
AndroidWebViewPackageInfo
Class that represents an Android WebView package info.
ASN1DERDecoder
ASN1DEREncoder
ASN1DistinguishedNames
ASN1Identifier
ASN1IdentifierClass
ASN1IdentifierTagNumber
ASN1Object
AuthorityInfoAccess
AuthorityInfoAccessExtension
Recognition for Authority Info Access Extension (1.3.6.1.5.5.7.1.1)
AuthorityKeyIdentifierExtension
Recognition for Authority Key Identifier Extension (2.5.29.35)
BasicConstraintExtension
Recognition for Basic Constraint Extension (2.5.29.19)
BrowserOptions
CallAsyncJavaScriptResult
Class that represents either a success or a failure, including an associated value in each case for InAppWebViewController.callAsyncJavaScript.
CertificatePoliciesExtension
Recognition for Certificate Policies Extension (2.5.29.32)
CertificatePolicy
CertificatePolicyQualifier
ChromeSafariBrowser
This class uses native Chrome Custom Tabs on Android and SFSafariViewController on iOS.
ChromeSafariBrowserActionButton
Class that represents a custom action button for a ChromeSafariBrowser instance.
ChromeSafariBrowserClassOptions
Class that represents the options that can be used for an ChromeSafariBrowser window.
ChromeSafariBrowserMenuItem
Class that represents a custom menu item for a ChromeSafariBrowser instance.
ChromeSafariBrowserOptions
ClientCertChallenge
Class that represents the challenge of the WebView.onReceivedClientCertRequest event. It provides all the information about the challenge.
ClientCertResponse
Class that represents the response used by the WebView.onReceivedClientCertRequest event.
ClientCertResponseAction
Class used by ClientCertResponse class.
CompressFormat
Class that represents the known formats a bitmap can be compressed into.
ConsoleMessage
Class representing a JavaScript console message from WebCore. This could be a issued by a call to one of the console logging functions (e.g. console.log('...')) or a JavaScript error on the page.
ConsoleMessageLevel
Class representing the level of a console message.
ContentBlocker
Class that represents a set of rules to use block content in the browser window.
ContentBlockerAction
Action associated to the trigger. The action tells to the WebView what to do when the trigger is matched. When a trigger matches a resource, the browser queues the associated action for execution. The WebView evaluates all the triggers, it executes the actions in order. When a domain matches a trigger, all rules after the triggered rule that specify the same action are skipped. Group the rules with similar actions together to improve performance.
ContentBlockerActionType
Class that represents the kind of action that can be used with a ContentBlockerTrigger.
ContentBlockerTrigger
Trigger of the content blocker. The trigger tells to the WebView when to perform the corresponding action. A trigger dictionary must include an ContentBlockerTrigger.urlFilter, which specifies a pattern to match the URL against. The remaining properties are optional and modify the behavior of the trigger. For example, you can limit the trigger to specific domains or have it not apply when a match is found on a specific domain.
ContentBlockerTriggerLoadType
Class that represents the possible load type for a ContentBlockerTrigger.
ContentBlockerTriggerResourceType
Class that represents the possible resource type defined for a ContentBlockerTrigger.
ContentWorld
Class that represents an object that defines a scope of execution for JavaScript code and which you use to prevent conflicts between different scripts.
ContextMenu
Class that represents the WebView context menu. It used by WebView.contextMenu.
ContextMenuItem
Class that represent an item of the ContextMenu.
ContextMenuOptions
Class that represents available options used by ContextMenu.
Class that represents a cookie returned by the CookieManager.
CookieManager
Class that implements a singleton object (shared instance) which manages the cookies used by WebView instances. On Android, it is implemented using CookieManager. On iOS, it is implemented using WKHTTPCookieStore.
CreateWindowAction
Class that represents the navigation request used by the WebView.onCreateWindow event.
CRLDistributionPointsExtension
CrossOrigin
Class that represents the crossorigin content attribute on media elements, which is a CORS settings attribute. It could be used with ScriptHtmlTagAttributes and CSSLinkHtmlTagAttributes when fetching a resource <link> or a <script> (or resources fetched by the <script>).
CSSLinkHtmlTagAttributes
Class that represents the possible CSS stylesheet <link> HTML attributes to be set used by InAppWebViewController.injectCSSFileFromUrl.
CustomSchemeResponse
Class representing the response returned by the WebView.onLoadResourceCustomScheme event. It allows to load a specific resource. The resource data must be encoded to base64.
CustomTabsShareState
Android-specific class representing the share state that should be applied to the custom tab.
DownloadStartRequest
Class representing a download request of the WebView used by the event WebView.onDownloadStartRequest.
Favicon
Class that represents a favicon of a website. It is used by InAppWebViewController.getFavicons method.
FetchRequest
Class that represents a HTTP request created with JavaScript using the Fetch API.
FetchRequestAction
Class used by FetchRequest class.
FetchRequestCredential
Class that is an interface for FetchRequestCredentialDefault, FetchRequestFederatedCredential and FetchRequestPasswordCredential classes.
FetchRequestCredentialDefault
Class that represents the default credentials used by an FetchRequest.
FetchRequestFederatedCredential
Class that represents a FederatedCredential type of credentials.
FetchRequestPasswordCredential
Class that represents a PasswordCredential type of credentials.
FormResubmissionAction
Class that represents the action to take used by the WebView.androidOnFormResubmission event.
GeolocationPermissionShowPromptResponse
Class used by the host application to set the Geolocation permission state for an origin during the WebView.androidOnGeolocationPermissionsShowPrompt event.
HeadlessInAppWebView
Class that represents a WebView in headless mode. It can be used to run a WebView in background without attaching an InAppWebView to the widget tree.
HttpAuthCredentialDatabase
Class that implements a singleton object (shared instance) which manages the shared HTTP auth credentials cache. On iOS, this class uses the URLCredentialStorage class. On Android, this class has a custom implementation using android.database.sqlite.SQLiteDatabase because WebViewDatabase doesn't offer the same functionalities as iOS URLCredentialStorage.
HttpAuthenticationChallenge
Class that represents the challenge of the WebView.onReceivedHttpAuthRequest event. It provides all the information about the challenge.
HttpAuthResponse
Class that represents the response used by the WebView.onReceivedHttpAuthRequest event.
HttpAuthResponseAction
Class used by HttpAuthResponse class.
HTTPCookieSameSitePolicy
Class that represents the same site policy of a cookie. Used by the Cookie class.
InAppBrowser
This class uses the native WebView of the platform. The webViewController field can be used to access the InAppWebViewController API.
InAppBrowserClassOptions
Class that represents the options that can be used for an InAppBrowser WebView.
InAppBrowserOptions
This class represents all the cross-platform InAppBrowser options available.
InAppLocalhostServer
This class allows you to create a simple server on http://localhost:[port]/ in order to be able to load your assets file on a server. The default port value is 8080.
InAppWebView
Flutter Widget for adding an inline native WebView integrated in the flutter widget tree.
InAppWebViewController
Controls a WebView, such as an InAppWebView widget instance, a HeadlessInAppWebView instance or InAppBrowser WebView instance.
InAppWebViewGroupOptions
Class that represents the options that can be used for a WebView.
InAppWebViewHitTestResult
Class that represents the hit result for hitting an HTML elements.
InAppWebViewHitTestResultType
Class representing the InAppWebViewHitTestResult type.
InAppWebViewInitialData
Initial data as a content for an WebView instance, using baseUrl as the base URL for it.
InAppWebViewOptions
This class represents all the cross-platform WebView options available.
InAppWebViewRect
A class that represents a structure that contains the location and dimensions of a rectangle.
IOSCookieManager
Class that contains only iOS-specific methods of CookieManager.
IOSInAppBrowserOptions
This class represents all the iOS-only InAppBrowser options available.
IOSInAppWebViewController
Class represents the iOS controller that contains only iOS-specific methods for the WebView.
IOSInAppWebViewOptions
This class represents all the iOS-only WebView options available.
IOSNavigationResponseAction
Class that is used by WebView.iosOnNavigationResponse event. It represents the policy to pass back to the decision handler.
IOSNSAttributedString
An iOS-specific class that represents a string with associated attributes used by the PullToRefreshController and PullToRefreshOptions classes.
IOSNSAttributedStringTextEffectStyle
An iOS-specific Class that represents the supported proxy types.
IOSNSUnderlineStyle
An iOS-specific Class that represents the constants for the underline style and strikethrough style attribute keys.
IOSNSURLProtectionSpaceAuthenticationMethod
An iOS-specific Class that represents the constants describing known values of the URLProtectionSpace.iosAuthenticationMethod property.
IOSNSURLProtectionSpaceProxyType
An iOS-specific Class that represents the supported proxy types.
IosOptions
IOSSafariDismissButtonStyle
An iOS-specific class used to set the custom style for the dismiss button.
IOSSafariOptions
This class represents all the iOS-only ChromeSafariBrowser options available.
IOSShouldAllowDeprecatedTLSAction
Class that is used by WebView.iosShouldAllowDeprecatedTLS event. It represents the policy to pass back to the decision handler.
IOSSslError
Class that represents the iOS-specific primary error associated to the server SSL certificate. Used by the ServerTrustChallenge class.
IOSUIModalPresentationStyle
An iOS-specific class used to specify the modal presentation style when presenting a view controller.
IOSUIModalTransitionStyle
An iOS-specific class used to specify the transition style when presenting a view controller.
IOSUIScrollViewContentInsetAdjustmentBehavior
An iOS-specific class used to configure how safe area insets are added to the adjusted content inset.
IOSUIScrollViewDecelerationRate
Class that represents a floating-point value that determines the rate of deceleration after the user lifts their finger.
IOSURLCredentialPersistence
An iOS-specific class that represents the constants that specify how long the credential will be kept.
IOSURLRequestCachePolicy
An iOS-specific Class that represents the constants used to specify interaction with the cached responses.
IOSURLRequestNetworkServiceType
An iOS-specific Class that represents the constants that specify how a request uses network resources.
IOSURLResponse
IOSWebStorageManager
Class that represents various types of data that a website might make use of. This includes cookies, disk and memory caches, and persistent data such as WebSQL, IndexedDB databases, and local storage.
IOSWKDataDetectorTypes
An iOS-specific class used to specify a dataDetectoryTypes value that adds interactivity to web content that matches the value.
IOSWKFrameInfo
An object that contains information about a frame on a webpage.
IOSWKNavigationResponse
An iOS-specific Class that represents the navigation response used by the WebView.iosOnNavigationResponse event.
IOSWKNavigationType
Class that represents the type of action triggering a navigation on iOS for the WebView.shouldOverrideUrlLoading event.
IOSWKPDFConfiguration
An iOS-specific class that represents the configuration data to use when generating a PDF representation of a web view’s contents.
IOSWKSecurityOrigin
An object that identifies the origin of a particular resource.
IOSWKSelectionGranularity
An iOS-specific class used to set the level of granularity with which the user can interactively select content in the web view.
IOSWKWebsiteDataRecord
Class that represents website data, grouped by domain name using the public suffix list.
IOSWKWebsiteDataType
Class that represents a website data type.
IOSWKWindowFeatures
An iOS-specific class that specifies optional attributes for the containing window when a new web view is requested.
JavaScriptReplyProxy
This class represents the JavaScript object injected by InAppWebViewController.addWebMessageListener. An instance will be given by WebMessageListener.onPostMessage. The app can use postMessage(String) to talk to the JavaScript context.
JsAlertRequest
Class that represents the request of the WebView.onJsAlert event.
JsAlertResponse
Class that represents the response used by the WebView.onJsAlert event to control a JavaScript alert dialog.
JsAlertResponseAction
Class used by JsAlertResponse class.
JsBeforeUnloadRequest
Class that represents the request of the WebView.androidOnJsBeforeUnload event.
JsBeforeUnloadResponse
Class that represents the response used by the WebView.androidOnJsBeforeUnload event to control a JavaScript alert dialog.
JsBeforeUnloadResponseAction
Class used by JsBeforeUnloadResponse class.
JsConfirmRequest
Class that represents the request of the WebView.onJsConfirm event.
JsConfirmResponse
Class that represents the response used by the WebView.onJsConfirm event to control a JavaScript confirm dialog.
JsConfirmResponseAction
Class used by JsConfirmResponse class.
JsPromptRequest
Class that represents the request of the WebView.onJsPrompt event.
JsPromptResponse
Class that represents the response used by the WebView.onJsPrompt event to control a JavaScript prompt dialog.
JsPromptResponseAction
Class used by JsPromptResponse class.
KeyUsage
LoadedResource
Class representing a resource response of the WebView. It is used by the method WebView.onLoadResource.
LocalStorage
Class that provides methods to manage the JavaScript window.localStorage object. It used by WebStorage.
LoginRequest
Class used by WebView.androidOnReceivedLoginRequest event.
MetaTag
Class that represents a <meta> HTML tag. It is used by the InAppWebViewController.getMetaTags method.
MetaTagAttribute
Class that represents an attribute of a <meta> HTML tag. It is used by the MetaTag class.
An object that contains information about an action that causes navigation to occur.
Class that is used by WebView.shouldOverrideUrlLoading event. It represents the policy to pass back to the decision handler.
OID
PermissionRequestResponse
Class that represents the response used by the WebView.androidOnPermissionRequest event.
PermissionRequestResponseAction
Class used by PermissionRequestResponse class.
PullToRefreshController
A standard controller that can initiate the refreshing of a scroll view’s contents. This should be used whenever the user can refresh the contents of a WebView via a vertical swipe gesture.
PullToRefreshOptions
ReferrerPolicy
Class that represents a Referrer-Policy HTTP header. It could be used with ScriptHtmlTagAttributes and CSSLinkHtmlTagAttributes when fetching a resource <link> or a <script> (or resources fetched by the <script>).
RendererPriority
Class used by RendererPriorityPolicy class.
RendererPriorityPolicy
Class that represents the priority policy will be used to determine whether an out of process renderer should be considered to be a target for OOM killing. When a WebView is destroyed it will cease to be considerered when calculating the renderer priority. Once no WebViews remain associated with the renderer, the priority of the renderer will be reduced to RendererPriority.RENDERER_PRIORITY_WAIVED. The default policy is to set the priority to RendererPriority.RENDERER_PRIORITY_IMPORTANT regardless of visibility, and this should not be changed unless the caller also handles renderer crashes with WebView.androidOnRenderProcessGone. Any other setting will result in WebView renderers being killed by the system more aggressively than the application.
RenderProcessGoneDetail
Class that provides more specific information about why the render process exited. It is used by the WebView.androidOnRenderProcessGone event.
RequestFocusNodeHrefResult
Class that represents the result used by the InAppWebViewController.requestFocusNodeHref method.
RequestImageRefResult
Class that represents the result used by the InAppWebViewController.requestImageRef method.
SafeBrowsingResponse
Class that represents the response used by the WebView.androidOnSafeBrowsingHit event. It is used to indicate an action to take when hitting a malicious URL.
SafeBrowsingResponseAction
Class used by SafeBrowsingResponse class.
SafeBrowsingThreat
Class that represents the reason the resource was caught by Safe Browsing.
ScreenshotConfiguration
Class that represents the configuration data to use when generating an image from a web view’s contents using InAppWebViewController.takeScreenshot.
ScriptHtmlTagAttributes
Class that represents the possible the <script> HTML attributes to be set used by InAppWebViewController.injectJavascriptFileFromUrl.
ServerTrustAuthResponse
ServerTrustAuthResponse class represents the response used by the WebView.onReceivedServerTrustAuthRequest event.
ServerTrustAuthResponseAction
Class used by ServerTrustAuthResponse class.
ServerTrustChallenge
Class that represents the challenge of the WebView.onReceivedServerTrustAuthRequest event. It provides all the information about the challenge.
SessionStorage
Class that provides methods to manage the JavaScript window.sessionStorage object. It used by WebStorage.
SslCertificate
SSL certificate info (certificate details) class.
SslCertificateDName
Distinguished name helper class. Used by SslCertificate.
SslError
Class that represents an SSL Error.
Storage
Class that provides methods to manage the JavaScript Storage object. It is used by LocalStorage and SessionStorage.
SubjectKeyIdentifierExtension
Recognition for Subject Key Identifier Extension (2.5.29.14)
TrustedWebActivityDefaultDisplayMode
Android-class that represents the default display mode of a Trusted Web Activity. The system UI (status bar, navigation bar) is shown, and the browser toolbar is hidden while the user is on a verified origin.
TrustedWebActivityDisplayMode
Android-class that represents display mode of a Trusted Web Activity.
TrustedWebActivityImmersiveDisplayMode
Android-class that represents the default display mode of a Trusted Web Activity. The system UI (status bar, navigation bar) is shown, and the browser toolbar is hidden while the user is on a verified origin.
TrustedWebActivityScreenOrientation
Android-specific class representing Screen Orientation Lock type value of a Trusted Web Activity: https://www.w3.org/TR/screen-orientation/#screenorientation-interface
URLAuthenticationChallenge
Class that represents a challenge from a server requiring authentication from the client. It provides all the information about the challenge.
URLCredential
Class that represents an authentication credential consisting of information specific to the type of credential and the type of persistent storage to use, if any.
URLProtectionSpace
Class that represents a protection space requiring authentication.
URLProtectionSpaceHttpAuthCredentials
Class that represents a URLProtectionSpace with all of its HttpAuthCredentials. It used by HttpAuthCredentialDatabase.getAllAuthCredentials.
URLRequest
A URL load request that is independent of protocol or URL scheme.
UserPreferredContentMode
Class that represents the content mode to prefer when loading and rendering a webpage.
UserScript
Class that represents a script that the WebView injects into the web page.
UserScriptInjectionTime
Class that represents contains the constants for the times at which to inject script content into a WebView used by an UserScript.
WebArchiveFormat
Class that represents the known Web Archive formats used when saving a web page.
WebHistory
This class contains a snapshot of the current back/forward list for a WebView.
WebHistoryItem
A convenience class for accessing fields in an entry in the back/forward list of a WebView. Each WebHistoryItem is a snapshot of the requested history item.
WebMessage
The Dart representation of the HTML5 PostMessage event. See https://html.spec.whatwg.org/multipage/comms.html#the-messageevent-interfaces for definition of a MessageEvent in HTML5.
WebMessageChannel
The representation of the HTML5 message channels.
WebMessageListener
This listener receives messages sent on the JavaScript object which was injected by InAppWebViewController.addWebMessageListener.
WebMessagePort
The representation of the HTML5 message ports.
WebResourceRequest
Class representing a resource request of the WebView used by the event WebView.androidShouldInterceptRequest. NOTE: available only on Android.
WebResourceResponse
Class representing a resource response of the WebView used by the event WebView.androidShouldInterceptRequest. NOTE: available only on Android.
WebStorage
Class that provides access to the JavaScript Web Storage API: window.sessionStorage and window.localStorage. It used by InAppWebViewController.webStorage.
WebStorageItem
Class that represents a single web storage item of the JavaScript window.sessionStorage and window.localStorage objects.
WebStorageManager
Class that implements a singleton object (shared instance) which manages the web storage used by WebView instances. On Android, it is implemented using WebStorage. On iOS, it is implemented using WKWebsiteDataStore.default().
WebStorageType
Class that represents the type of Web Storage: localStorage or sessionStorage. Used by the Storage class.
WebView
Abstract class that represents a WebView. Used by InAppWebView and HeadlessInAppWebView.
WebViewImplementation
Class that represents the WebView native implementation to be used.
WebViewOptions
WebViewRenderProcessAction
Class that represents the action to take used by the WebView.androidOnRenderProcessUnresponsive and WebView.androidOnRenderProcessResponsive event to terminate the Android WebViewRenderProcess.
X509Certificate
Class that represents a X.509 certificate. This provides a standard way to access all the attributes of an X.509 certificate.
X509Extension
X509PublicKey

Functions

firstLeafValue({required ASN1Object block}) → dynamic
toIntValue(List<int> data) → BigInt?

Typedefs

JavaScriptHandlerCallback = dynamic Function(List arguments)
This type represents a callback, added with InAppWebViewController.addJavaScriptHandler, that listens to post messages sent from JavaScript.
OnPostMessageCallback = void Function(String? message, Uri? sourceOrigin, bool isMainFrame, JavaScriptReplyProxy replyProxy)
The listener for handling WebMessageListener events sent by a postMessage() on the injected JavaScript object.
WebMessageCallback = void Function(String? message)
The listener for handling WebMessagePort events. The message callback methods are called on the main thread.