flutter_inappwebview library

Classes

ActionModeMenuItem
Class used to disable the action mode menu items.
ActivityButton
Class that represents a custom button to show in SFSafariViewController's toolbar. When tapped, it will invoke a Share or Action Extension bundled with your app. The default VoiceOver description of this button is the CFBundleDisplayName set in the extension's Info.plist.
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. Use CacheMode instead.
AndroidChromeCustomTabsOptions
This class represents all the Android-only PlatformChromeSafariBrowser options available. Use ChromeSafariBrowserSettings instead.
AndroidForceDark
An Android-specific class used to indicate the force dark mode.
AndroidInAppBrowserOptions
This class represents all the Android-only PlatformInAppBrowser options available. Use InAppBrowserSettings instead.
AndroidInAppWebViewController
Use InAppWebViewController instead.
AndroidInAppWebViewOptions
Use InAppWebViewSettings instead.
AndroidLayoutAlgorithm
An Android-specific class used to set the underlying layout algorithm. Use LayoutAlgorithm instead.
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. Use OverScrollMode instead.
AndroidPullToRefreshSize
Android-specific class representing the size of the refresh indicator. Use PullToRefreshSize instead.
AndroidResource
Class that represents an Android resource file.
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. Use SslErrorType instead.
AndroidVerticalScrollbarPosition
An Android-specific class used to configure the position of the vertical scroll bar. Use VerticalScrollbarPosition instead.
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. Use WebStorageOrigin instead.
AndroidWebViewFeature
Class that represents an Android-specific utility class for checking which WebView Support Library features are supported on the device. Use WebViewFeature instead.
AndroidWebViewPackageInfo
Class that represents an Android WebView package info. Use WebViewPackageInfo instead.
ASN1DERDecoder
ASN1DEREncoder
ASN1DistinguishedNames
ASN1Identifier
ASN1IdentifierClass
ASN1IdentifierTagNumber
ASN1Object
AssetsPathHandler
Handler class to open a file from assets directory in the application APK.
AttributedString
Class that represents a string with associated attributes used by the PlatformPullToRefreshController and PullToRefreshSettings classes.
AttributedStringTextEffectStyle
Class that represents the supported proxy types.
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
CacheMode
Class used to override the way the cache is used.
CallAsyncJavaScriptResult
Class that represents either a success or a failure, including an associated value in each case for PlatformInAppWebViewController.callAsyncJavaScript.
CertificatePoliciesExtension
Recognition for Certificate Policies Extension (2.5.29.32)
CertificatePolicy
CertificatePolicyQualifier
ChromeSafariBrowser
Class that provides a visible standard interface for browsing the web. It presents a self-contained web interface inside your app.
ChromeSafariBrowserActionButton
Class that represents a custom action button for a PlatformChromeSafariBrowser instance.
ChromeSafariBrowserClassOptions
Class that represents the options that can be used for an ChromeSafariBrowser window. Use ChromeSafariBrowserSettings instead.
ChromeSafariBrowserMenuItem
Class that represents a custom menu item for a PlatformChromeSafariBrowser instance.
ChromeSafariBrowserOptions
ChromeSafariBrowserSecondaryToolbar
Class that represents the RemoteViews that will be shown on the secondary toolbar of a custom tab.
ChromeSafariBrowserSecondaryToolbarClickableID
Class that represents a clickable ID item of the secondary toolbar for a PlatformChromeSafariBrowser instance.
ChromeSafariBrowserSettings
Class that represents the settings that can be used for an ChromeSafariBrowser window.
ClientCertChallenge
Class that represents the challenge of the PlatformWebViewCreationParams.onReceivedClientCertRequest event. It provides all the information about the challenge.
ClientCertResponse
Class that represents the response used by the PlatformWebViewCreationParams.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.
ContentBlockerTriggerLoadContext
Class that represents the kind of load context that can be used with a ContentBlockerTrigger.
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 PlatformWebViewCreationParams.contextMenu.
ContextMenuItem
Class that represent an item of the ContextMenu.
ContextMenuOptions
Use ContextMenuSettings instead.
ContextMenuSettings
Class that represents available settings used by ContextMenu.
Class that represents a cookie returned by the PlatformCookieManager.
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 PlatformWebViewCreationParams.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 PlatformInAppWebViewController.injectCSSFileFromUrl.
CustomPathHandler
Custom handler class used to implement a custom logic to open a file.
CustomSchemeResponse
Class representing the response returned by the PlatformWebViewCreationParams.onLoadResourceWithCustomScheme event. It allows to load a specific resource. The resource data must be encoded to base64.
CustomTabsNavigationEventType
The type corresponding to the navigation event of PlatformChromeSafariBrowserEvents.onNavigationEvent.
CustomTabsPostMessageResultType
Custom Tabs postMessage result type.
CustomTabsRelationType
Custom Tabs relation for which the result is available.
CustomTabsShareState
Class representing the share state that should be applied to the custom tab.
DataDetectorTypes
Class used to specify a dataDetectoryTypes value that adds interactivity to web content that matches the value.
DebugLoggingSettings
Class that represents the debug logging settings.
DefaultInAppLocalhostServer
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 local server. The default port value is 8080.
DefaultInAppLocalhostServerCreationParams
Object specifying creation parameters for creating a DefaultInAppLocalhostServer.
DismissButtonStyle
Class used to set the custom style for the dismiss button.
Disposable
DownloadStartRequest
Class representing a download request of the WebView used by the event PlatformWebViewCreationParams.onDownloadStartRequest.
Favicon
Class that represents a favicon of a website. It is used by PlatformInAppWebViewController.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.
FindInteractionController
This class represents the controller used by the WebView to add text-finding capabilities, such as the "Find on page" feature.
FindSession
ForceDark
Class used to indicate the force dark mode.
ForceDarkStrategy
Class used to indicate how WebView content should be darkened.
FormResubmissionAction
Class that represents the action to take used by the PlatformWebViewCreationParams.onFormResubmission event.
FrameInfo
An object that contains information about a frame on a webpage.
GeolocationPermissionShowPromptResponse
Class used by the host application to set the Geolocation permission state for an origin during the PlatformWebViewCreationParams.onGeolocationPermissionsShowPrompt 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 and MacOS, 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 PlatformWebViewCreationParams.onReceivedHttpAuthRequest event. It provides all the information about the challenge.
HttpAuthResponse
Class that represents the response used by the PlatformWebViewCreationParams.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 represents a native WebView displayed on top of the Flutter App, so it's not integrated into the Flutter widget tree. It uses the native WebView of the platform. The webViewController field can be used to access the PlatformInAppWebViewController API.
InAppBrowserClassOptions
Class that represents the options that can be used for an InAppBrowser WebView. Use InAppBrowserClassSettings instead.
InAppBrowserClassSettings
Class that represents the settings that can be used for an InAppBrowser instance.
InAppBrowserMenuItem
Class that represents a custom menu item for a PlatformInAppBrowser instance.
InAppBrowserOptions
This class represents all the cross-platform InAppBrowser options available. Use InAppBrowserClassSettings instead.
InAppBrowserSettings
This class represents all InAppBrowser settings 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 local server. The default port value is 8080.
InAppWebView
Flutter Widget for adding an inline native WebView integrated in the flutter widget tree.
InAppWebViewController
InAppWebViewControllerKeepAliveProps
Used internally to save and restore PlatformInAppWebViewController properties for the keep alive feature.
InAppWebViewGroupOptions
Class that represents the options that can be used for a WebView. Use InAppWebViewSettings instead.
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.
InAppWebViewKeepAlive
Class used to keep alive a PlatformInAppWebViewWidget.
InAppWebViewOptions
Use InAppWebViewSettings instead.
InAppWebViewPlatform
Interface for a platform implementation of a WebView.
InAppWebViewRect
A class that represents a structure that contains the location and dimensions of a rectangle.
InAppWebViewSettings
This class represents all the WebView settings available.
InternalStoragePathHandler
Handler class to open files from application internal storage. For more information about android storage please refer to Android Developers Docs: Data and file storage overview.
IOSCookieManager
Class that contains only iOS-specific methods of CookieManager. Use CookieManager instead.
IOSInAppBrowserOptions
This class represents all the iOS-only PlatformInAppBrowser options available. Use InAppBrowserSettings instead.
IOSInAppWebViewController
Use InAppWebViewController instead.
IOSInAppWebViewOptions
Use InAppWebViewSettings instead.
IOSNavigationResponseAction
Class that is used by PlatformWebViewCreationParams.onNavigationResponse event. It represents the policy to pass back to the decision handler. Use NavigationResponseAction instead.
IOSNSAttributedString
An iOS-specific class that represents a string with associated attributes used by the PlatformPullToRefreshController and PullToRefreshOptions classes. Use AttributedString instead.
IOSNSAttributedStringTextEffectStyle
An iOS-specific Class that represents the supported proxy types. Use AttributedStringTextEffectStyle instead.
IOSNSUnderlineStyle
An iOS-specific Class that represents the constants for the underline style and strikethrough style attribute keys. Use UnderlineStyle instead.
IOSNSURLProtectionSpaceAuthenticationMethod
An iOS-specific Class that represents the constants describing known values of the URLProtectionSpace.authenticationMethod property. Use URLProtectionSpaceAuthenticationMethod instead.
IOSNSURLProtectionSpaceProxyType
An iOS-specific Class that represents the supported proxy types. Use URLProtectionSpaceProxyType instead.
IosOptions
IOSSafariDismissButtonStyle
An iOS-specific class used to set the custom style for the dismiss button.
IOSSafariOptions
This class represents all the iOS-only PlatformChromeSafariBrowser options available. Use ChromeSafariBrowserSettings instead.
IOSShouldAllowDeprecatedTLSAction
Class that is used by PlatformWebViewCreationParams.shouldAllowDeprecatedTLS event. It represents the policy to pass back to the decision handler. Use ShouldAllowDeprecatedTLSAction instead.
IOSSslError
Class that represents the iOS-specific primary error associated to the server SSL certificate. Used by the ServerTrustChallenge class. Use SslErrorType instead.
IOSUIModalPresentationStyle
An iOS-specific class used to specify the modal presentation style when presenting a view controller. Use ModalPresentationStyle instead.
IOSUIModalTransitionStyle
An iOS-specific class used to specify the transition style when presenting a view controller. Use ModalTransitionStyle instead.
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. Use ScrollViewDecelerationRate instead.
IOSURLCredentialPersistence
An iOS-specific class that represents the constants that specify how long the credential will be kept. Use URLCredentialPersistence instead.
IOSURLRequestCachePolicy
An iOS-specific Class that represents the constants used to specify interaction with the cached responses. Use URLRequestCachePolicy instead.
IOSURLRequestNetworkServiceType
An iOS-specific Class that represents the constants that specify how a request uses network resources. Use URLRequestNetworkServiceType instead.
IOSURLResponse
Use URLResponse instead.
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 PlatformWebViewCreationParams.onNavigationResponse event. Use NavigationResponse instead.
IOSWKNavigationType
Class that represents the type of action triggering a navigation on iOS for the PlatformWebViewCreationParams.shouldOverrideUrlLoading event. Use NavigationType instead.
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. Use SelectionGranularity instead.
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. Use WindowFeatures instead.
IWebMessagePort
JavaScriptReplyProxy
This class represents the JavaScript object injected by PlatformInAppWebViewController.addWebMessageListener. An instance will be given by PlatformWebMessageListener.onPostMessage. The app can use postMessage(String) to talk to the JavaScript context.
JsAlertRequest
Class that represents the request of the PlatformWebViewCreationParams.onJsAlert event.
JsAlertResponse
Class that represents the response used by the PlatformWebViewCreationParams.onJsAlert event to control a JavaScript alert dialog.
JsAlertResponseAction
Class used by JsAlertResponse class.
JsBeforeUnloadRequest
Class that represents the request of the PlatformWebViewCreationParams.onJsBeforeUnload event.
JsBeforeUnloadResponse
Class that represents the response used by the PlatformWebViewCreationParams.onJsBeforeUnload event to control a JavaScript alert dialog.
JsBeforeUnloadResponseAction
Class used by JsBeforeUnloadResponse class.
JsConfirmRequest
Class that represents the request of the PlatformWebViewCreationParams.onJsConfirm event.
JsConfirmResponse
Class that represents the response used by the PlatformWebViewCreationParams.onJsConfirm event to control a JavaScript confirm dialog.
JsConfirmResponseAction
Class used by JsConfirmResponse class.
JsPromptRequest
Class that represents the request of the PlatformWebViewCreationParams.onJsPrompt event.
JsPromptResponse
Class that represents the response used by the PlatformWebViewCreationParams.onJsPrompt event to control a JavaScript prompt dialog.
JsPromptResponseAction
Class used by JsPromptResponse class.
KeyUsage
LayoutAlgorithm
Class used to set the underlying layout algorithm.
LayoutInDisplayCutoutMode
Class representing the share state that should be applied to the custom tab.
LoadedResource
Class representing a resource response of the WebView. It is used by the method PlatformWebViewCreationParams.onLoadResource.
LocalStorage
Class that provides methods to manage the JavaScript window.localStorage object. It used by PlatformWebStorage.
LoginRequest
Class used by PlatformWebViewCreationParams.onReceivedLoginRequest event.
MediaCaptureState
Class that describes whether a media device, like a camera or microphone, is currently capturing audio or video.
MediaPlaybackState
Class that describes whether an audio or video presentation is playing, paused, or suspended.
MetaTag
Class that represents a <meta> HTML tag. It is used by the PlatformInAppWebViewController.getMetaTags method.
MetaTagAttribute
Class that represents an attribute of a <meta> HTML tag. It is used by the MetaTag class.
MixedContentMode
Class used to configure the WebView's behavior when a secure origin attempts to load a resource from an insecure origin.
ModalPresentationStyle
Class used to specify the modal presentation style when presenting a view controller.
ModalTransitionStyle
Class used to specify the transition style when presenting a view controller.
An object that contains information about an action that causes navigation to occur.
Class that is used by PlatformWebViewCreationParams.shouldOverrideUrlLoading event. It represents the policy to pass back to the decision handler.
Class that represents the navigation response used by the PlatformWebViewCreationParams.onNavigationResponse event.
Class that is used by PlatformWebViewCreationParams.onNavigationResponse event. It represents the policy to pass back to the decision handler.
Class that represents the type of action triggering a navigation for the PlatformWebViewCreationParams.shouldOverrideUrlLoading event.
OID
OverScrollMode
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.
PathHandler
A handler that produces responses for a registered path.
PDFConfiguration
Class that represents the configuration data to use when generating a PDF representation of a web view’s contents.
PermissionRequest
Class that represents the response used by the PlatformWebViewCreationParams.onPermissionRequest event.
PermissionRequestResponse
Class that represents the response used by the PlatformWebViewCreationParams.androidOnPermissionRequest event. Use PermissionResponse instead.
PermissionRequestResponseAction
Class used by PermissionRequestResponse class. Use PermissionResponseAction instead.
PermissionResourceType
Class that represents a type of resource used to ask user's permission.
PermissionResponse
Class that represents the response used by the PlatformWebViewCreationParams.onPermissionRequest event.
PermissionResponseAction
Class used by PermissionResponse class.
PlatformAssetsPathHandler
Handler class to open a file from assets directory in the application APK.
PlatformAssetsPathHandlerCreationParams
Object specifying creation parameters for creating a PlatformAssetsPathHandler.
PlatformChromeSafariBrowser
Class that provides a visible standard interface for browsing the web. It presents a self-contained web interface inside your app.
PlatformChromeSafariBrowserCreationParams
Object specifying creation parameters for creating a PlatformChromeSafariBrowser.
PlatformChromeSafariBrowserEvents
PlatformCookieManager
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.
PlatformCookieManagerCreationParams
Object specifying creation parameters for creating a PlatformCookieManager.
PlatformCustomPathHandler
Custom handler class used to implement a custom logic to open a file.
PlatformCustomPathHandlerCreationParams
Object specifying creation parameters for creating a PlatformCustomPathHandler.
PlatformFindInteractionController
This class represents the controller used by the WebView to add text-finding capabilities, such as the "Find on page" feature.
PlatformFindInteractionControllerCreationParams
Object specifying creation parameters for creating a PlatformFindInteractionController.
PlatformHeadlessInAppWebView
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.
PlatformHeadlessInAppWebViewCreationParams
Object specifying creation parameters for creating a PlatformInAppWebViewWidget.
PlatformHttpAuthCredentialDatabase
Class that implements a singleton object (shared instance) which manages the shared HTTP auth credentials cache. On iOS and MacOS, 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.
PlatformHttpAuthCredentialDatabaseCreationParams
Object specifying creation parameters for creating a PlatformHttpAuthCredentialDatabase.
PlatformInAppBrowser
This class represents a native WebView displayed on top of the Flutter App, so it's not integrated into the Flutter widget tree. It uses the native WebView of the platform. The webViewController field can be used to access the PlatformInAppWebViewController API.
PlatformInAppBrowserCreationParams
Object specifying creation parameters for creating a PlatformInAppBrowser.
PlatformInAppBrowserEvents
PlatformInAppLocalhostServer
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 local server. The default port value is 8080.
PlatformInAppLocalhostServerCreationParams
Object specifying creation parameters for creating a PlatformInAppLocalhostServer.
PlatformInAppWebViewController
Controls a WebView, such as an InAppWebView widget instance, a HeadlessInAppWebView instance or PlatformInAppBrowser WebView instance.
PlatformInAppWebViewControllerCreationParams
Object specifying creation parameters for creating a PlatformInAppWebViewController.
PlatformInAppWebViewWidget
Interface for a platform implementation of a web view widget.
PlatformInAppWebViewWidgetCreationParams
Object specifying creation parameters for creating a PlatformInAppWebViewWidget.
PlatformInternalStoragePathHandler
Handler class to open files from application internal storage. For more information about android storage please refer to Android Developers Docs: Data and file storage overview.
PlatformInternalStoragePathHandlerCreationParams
Object specifying creation parameters for creating a PlatformInternalStoragePathHandler.
PlatformJavaScriptReplyProxy
This class represents the JavaScript object injected by PlatformInAppWebViewController.addWebMessageListener. An instance will be given by PlatformWebMessageListener.onPostMessage. The app can use postMessage(String) to talk to the JavaScript context.
PlatformJavaScriptReplyProxyCreationParams
Object specifying creation parameters for creating a PlatformJavaScriptReplyProxy.
PlatformLocalStorage
Class that provides methods to manage the JavaScript window.localStorage object. It used by PlatformWebStorage.
PlatformLocalStorageCreationParams
Object specifying creation parameters for creating a PlatformLocalStorage.
PlatformPathHandler
A handler that produces responses for a registered path.
PlatformPathHandlerCreationParams
Object specifying creation parameters for creating a PlatformPathHandler.
PlatformPathHandlerEvents
Interface path handler events.
PlatformPrintJobController
Class representing a print job eventually returned by PlatformInAppWebViewController.printCurrentPage.
PlatformPrintJobControllerCreationParams
Object specifying creation parameters for creating a PlatformPrintJobController.
PlatformProcessGlobalConfig
Process Global Configuration for WebView. WebView has some process-global configuration parameters that cannot be changed once WebView has been loaded. This class allows apps to set these parameters.
PlatformProcessGlobalConfigCreationParams
Object specifying creation parameters for creating a PlatformProcessGlobalConfig.
PlatformProxyController
Manages setting and clearing a process-specific override for the Android system-wide proxy settings that govern network requests made by WebView.
PlatformProxyControllerCreationParams
Object specifying creation parameters for creating a PlatformProxyController.
PlatformPullToRefreshController
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.
PlatformPullToRefreshControllerCreationParams
Object specifying creation parameters for creating a PlatformPullToRefreshController.
PlatformResourcesPathHandler
Handler class to open a file from resources directory in the application APK.
PlatformResourcesPathHandlerCreationParams
Object specifying creation parameters for creating a PlatformResourcesPathHandler.
PlatformServiceWorkerController
Class that manages Service Workers used by WebView.
PlatformServiceWorkerControllerCreationParams
Object specifying creation parameters for creating a PlatformServiceWorkerController.
PlatformSessionStorage
Class that provides methods to manage the JavaScript window.sessionStorage object. It used by PlatformWebStorage.
PlatformSessionStorageCreationParams
Object specifying creation parameters for creating a PlatformSessionStorage.
PlatformStorage
Class that provides methods to manage the JavaScript Storage object. It is used by PlatformLocalStorage and PlatformSessionStorage.
PlatformStorageCreationParams
Object specifying creation parameters for creating a PlatformStorage.
PlatformTracingController
Manages tracing of WebViews. In particular provides functionality for the app to enable/disable tracing of parts of code and to collect tracing data. This is useful for profiling performance issues, debugging and memory usage analysis in production and real life scenarios.
PlatformTracingControllerCreationParams
Object specifying creation parameters for creating a PlatformTracingController.
PlatformWebAuthenticationSession
A session that an app uses to authenticate a user through a web service.
PlatformWebAuthenticationSessionCreationParams
Object specifying creation parameters for creating a PlatformWebAuthenticationSession.
PlatformWebMessageChannel
Disposes the web message channel.
PlatformWebMessageChannelCreationParams
Object specifying creation parameters for creating a PlatformWebMessageChannel.
PlatformWebMessageListener
This listener receives messages sent on the JavaScript object which was injected by PlatformInAppWebViewController.addWebMessageListener.
PlatformWebMessageListenerCreationParams
Object specifying creation parameters for creating a PlatformWebMessageListener.
PlatformWebMessagePort
The representation of the HTML5 message ports.
PlatformWebMessagePortCreationParams
Object specifying creation parameters for creating a PlatformWebMessagePort.
PlatformWebStorage
Class that provides access to the JavaScript Web Storage API: window.sessionStorage and window.localStorage. It used by PlatformInAppWebViewController.webStorage.
PlatformWebStorageCreationParams
Object specifying creation parameters for creating a PlatformWebStorage.
PlatformWebStorageManager
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 and MacOS, it is implemented using WKWebsiteDataStore.default().
PlatformWebStorageManagerCreationParams
Object specifying creation parameters for creating a PlatformWebStorageManager.
PlatformWebViewCreationParams<T>
Class that represents a WebView. Used by InAppWebView, HeadlessInAppWebView and the WebView of PlatformInAppBrowser.
PlatformWebViewEnvironment
Controls a WebView Environment used by WebView instances. Use dispose when not needed anymore to release references.
PlatformWebViewEnvironmentCreationParams
Object specifying creation parameters for creating a PlatformWebViewEnvironment.
PlatformWebViewFeature
Class that represents an Android-specific utility class for checking which WebView Support Library features are supported on the device.
PlatformWebViewFeatureCreationParams
Object specifying creation parameters for creating a PlatformWebViewFeature.
PrewarmingToken
Class that represents the Prewarming Token returned by PlatformChromeSafariBrowser.prewarmConnections.
Printer
Class representing the printer used by a PlatformPrintJobController.
PrintJobAttributes
Class representing the attributes of a PlatformPrintJobController. These attributes describe how the printed content should be laid out.
PrintJobColorMode
Class representing how the printed content of a PlatformPrintJobController should be laid out.
PrintJobController
Class representing a print job eventually returned by PlatformInAppWebViewController.printCurrentPage.
PrintJobDisposition
Class representing the constants that specify values for the print job disposition of a PlatformPrintJobController.
PrintJobDuplexMode
Class representing the orientation of a PlatformPrintJobController.
PrintJobInfo
Class representing the description of a PlatformPrintJobController. Note that the print jobs state may change over time and this class represents a snapshot of this state.
PrintJobMediaSize
Class representing the supported media size for a PlatformPrintJobController. Media size is the dimension of the media on which the content is printed.
PrintJobOrientation
Class representing the orientation of a PlatformPrintJobController.
PrintJobOutputType
Class representing the kind of printable content of a PlatformPrintJobController.
PrintJobPageOrder
Class representing the page order that will be used to generate the pages of a PlatformPrintJobController.
PrintJobPaginationMode
Class representing the constants that specify the different ways in which an image is divided into pages of a PlatformPrintJobController.
PrintJobRenderingQuality
Class representing the rendering quality of a PlatformPrintJobController.
PrintJobResolution
Class representing the supported resolution in DPI (dots per inch) for a PlatformPrintJobController. Resolution defines how many points with different color can be placed on one inch in horizontal or vertical direction of the target media. For example, a printer with 600 DPI can produce higher quality images the one with 300 DPI resolution.
PrintJobSettings
Class that represents the settings of a PlatformPrintJobController.
PrintJobState
Class representing the state of a PlatformPrintJobController.
ProcessGlobalConfig
Process Global Configuration for WebView. WebView has some process-global configuration parameters that cannot be changed once WebView has been loaded. This class allows apps to set these parameters.
ProcessGlobalConfigDirectoryBasePaths
Class that represents the settings used to configure the ProcessGlobalConfigSettings.directoryBasePaths.
ProcessGlobalConfigSettings
Class that represents the settings used to configure the PlatformProcessGlobalConfig.
ProxyController
Manages setting and clearing a process-specific override for the Android system-wide proxy settings that govern network requests made by WebView.
ProxyRule
Class that holds a scheme filter and a proxy URL.
ProxySchemeFilter
Class that represent scheme filters used by PlatformProxyController.
ProxySettings
Class that represents the settings used to configure the PlatformProxyController.
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
Use PullToRefreshSettings instead.
PullToRefreshSettings
Pull-To-Refresh Settings
PullToRefreshSize
Class representing the size of the refresh indicator.
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 PlatformWebViewCreationParams.onRenderProcessGone. 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 PlatformWebViewCreationParams.onRenderProcessGone event.
RequestFocusNodeHrefResult
Class that represents the result used by the PlatformInAppWebViewController.requestFocusNodeHref method.
RequestImageRefResult
Class that represents the result used by the PlatformInAppWebViewController.requestImageRef method.
ResourcesPathHandler
Handler class to open a file from resources directory in the application APK.
SafeBrowsingResponse
Class that represents the response used by the PlatformWebViewCreationParams.onSafeBrowsingHit 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.
Sandbox
Class that describes what to allow in the iframe.
ScreenshotConfiguration
Class that represents the configuration data to use when generating an image from a web view’s contents using PlatformInAppWebViewController.takeScreenshot.
ScriptHtmlTagAttributes
Class that represents the possible the <script> HTML attributes to be set used by PlatformInAppWebViewController.injectJavascriptFileFromUrl.
ScrollBarStyle
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 ScrollBarStyle.SCROLLBARS_INSIDE_OVERLAY or ScrollBarStyle.SCROLLBARS_INSIDE_INSET. If you want them to appear at the edge of the view, ignoring the padding, then you can use ScrollBarStyle.SCROLLBARS_OUTSIDE_OVERLAY or ScrollBarStyle.SCROLLBARS_OUTSIDE_INSET.
ScrollViewContentInsetAdjustmentBehavior
Class used to configure how safe area insets are added to the adjusted content inset.
ScrollViewDecelerationRate
Class that represents a floating-point value that determines the rate of deceleration after the user lifts their finger.
SearchResultDisplayStyle
Constants that describe the results summary the find panel UI includes.
SecurityOrigin
An object that identifies the origin of a particular resource.
SelectionGranularity
Class used to set the level of granularity with which the user can interactively select content in the web view.
ServerTrustAuthResponse
Class that represents the response used by the PlatformWebViewCreationParams.onReceivedServerTrustAuthRequest event.
ServerTrustAuthResponseAction
Class used by ServerTrustAuthResponse class.
ServerTrustChallenge
Class that represents the challenge of the PlatformWebViewCreationParams.onReceivedServerTrustAuthRequest event. It provides all the information about the challenge.
ServiceWorkerClient
Class used by clients to capture Service Worker related callbacks.
ServiceWorkerController
Class that manages Service Workers used by WebView.
SessionStorage
Class that provides methods to manage the JavaScript window.sessionStorage object. It used by PlatformWebStorage.
ShouldAllowDeprecatedTLSAction
Class that is used by PlatformWebViewCreationParams.shouldAllowDeprecatedTLS event. It represents the policy to pass back to the decision handler.
SslCertificate
SSL certificate info (certificate details) class.
SslCertificateDName
Distinguished name helper class. Used by SslCertificate.
SslError
Class that represents an SSL Error.
SslErrorType
Class that represents the SSL Primary error associated to the server SSL certificate. Used by the ServerTrustChallenge class.
Storage
Class that provides methods to manage the JavaScript Storage object. It is used by PlatformLocalStorage and PlatformSessionStorage.
SubjectKeyIdentifierExtension
Recognition for Subject Key Identifier Extension (2.5.29.14)
TracingCategory
Constants that describe the results summary the find panel UI includes.
TracingController
Manages tracing of WebViews. In particular provides functionality for the app to enable/disable tracing of parts of code and to collect tracing data. This is useful for profiling performance issues, debugging and memory usage analysis in production and real life scenarios.
TracingMode
Constants that describe the results summary the find panel UI includes.
TracingSettings
Class that represents the settings used to configure the PlatformTracingController.
TrustedWebActivityDefaultDisplayMode
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
Class that represents display mode of a Trusted Web Activity.
TrustedWebActivityImmersiveDisplayMode
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
Class representing Screen Orientation Lock type value of a Trusted Web Activity: https://www.w3.org/TR/screen-orientation/#screenorientation-interface
UIEventAttribution
Class that represents an object that contains event attribution information for Private Click Measurement.
UIImage
Class that represents an object that manages iOS and MacOS image data in your app.
UnderlineStyle
Class that represents the constants for the underline style and strikethrough style attribute keys.
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.
URLCredentialPersistence
Class that represents the constants that specify how long the credential will be kept.
URLProtectionSpace
Class that represents a protection space requiring authentication.
URLProtectionSpaceAuthenticationMethod
Class that represents the constants describing known values of the URLProtectionSpace.authenticationMethod property.
URLProtectionSpaceHttpAuthCredentials
Class that represents a URLProtectionSpace with all of its URLCredentials. It used by PlatformHttpAuthCredentialDatabase.getAllAuthCredentials.
URLProtectionSpaceProxyType
Class that represents the supported proxy types.
URLRequest
A URL load request that is independent of protocol or URL scheme.
URLRequestAttribution
Class that represents the constants used to indicate the entities that can make a network request.
URLRequestCachePolicy
Class that represents the constants used to specify interaction with the cached responses.
URLRequestNetworkServiceType
Class that represents the constants that specify how a request uses network resources.
URLResponse
The metadata associated with the response to a URL load request, independent of protocol and 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.
VerticalScrollbarPosition
Class used to configure the position of the vertical scroll bar.
WebArchiveFormat
Class that represents the known Web Archive formats used when saving a web page.
WebAuthenticationSession
A session that an app uses to authenticate a user through a web service.
WebAuthenticationSessionError
Class that represents the error code for a web authentication session error.
WebAuthenticationSessionSettings
Class that represents the settings that can be used for a PlatformWebAuthenticationSession.
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
Disposes the web message channel.
WebMessageListener
This listener receives messages sent on the JavaScript object which was injected by PlatformInAppWebViewController.addWebMessageListener.
WebMessagePort
The representation of the HTML5 message ports.
WebMessageType
The type corresponding to the WebMessage.
WebResourceError
Encapsulates information about errors occurred during loading of web resources.
WebResourceErrorType
Class that represents the error types returned by URL loading APIs.
WebResourceRequest
Class representing a resource request of the WebView.
WebResourceResponse
Class representing a resource response of the WebView.
WebsiteDataRecord
Class that represents website data, grouped by domain name using the public suffix list.
WebsiteDataType
Class that represents a website data type.
WebStorage
Class that provides access to the JavaScript Web Storage API: window.sessionStorage and window.localStorage. It used by PlatformInAppWebViewController.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 and MacOS, it is implemented using WKWebsiteDataStore.default().
WebStorageOrigin
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 PlatformWebStorageManager for details.
WebStorageType
Class that represents the type of Web Storage: localStorage or sessionStorage. Used by the PlatformStorage class.
WebUri
Class that implements the Uri interface to maintain also the raw string value used by Uri.parse.
WebViewAssetLoader
Helper class to load local files including application's static assets and resources using http(s):// URLs inside a WebView class. Loading local files using web-like URLs instead of file:// is desirable as it is compatible with the Same-Origin policy.
WebViewAssetLoader_
Helper class to load local files including application's static assets and resources using http(s):// URLs inside a WebView class. Loading local files using web-like URLs instead of file:// is desirable as it is compatible with the Same-Origin policy.
WebViewEnvironment
WebViewEnvironmentSettings
This class represents all the PlatformWebViewEnvironment settings available.
WebViewFeature
Class that represents an Android-specific utility class for checking which WebView Support Library features are supported on the device.
WebViewOptions
WebViewPackageInfo
Class that represents a WebView package info.
WebViewRenderProcessAction
Class that represents the action to take used by the PlatformWebViewCreationParams.onRenderProcessUnresponsive and PlatformWebViewCreationParams.onRenderProcessResponsive event to terminate the Android WebViewRenderProcess.
WindowFeatures
Class that specifies optional attributes for the containing window when a new web view is requested.
WindowStyleMask
Class that represents the flags that describe the browser window’s current style, such as if it’s resizable or in full-screen mode.
WindowTitlebarSeparatorStyle
Class that represents the type of separator that the app displays between the title bar and content of a browser window.
WindowType
Class that represents how a browser window should be added to the main window.
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

debugLog({required DebugLoggingSettings debugLoggingSettings, required String className, required String method, String? name, String? id, dynamic args}) → void
firstLeafValue({required ASN1Object block}) → dynamic
toIntValue(List<int> data) → BigInt?

Typedefs

JavaScriptHandlerCallback = dynamic Function(List arguments)
This type represents a callback, added with PlatformInAppWebViewController.addJavaScriptHandler, that listens to post messages sent from JavaScript.
OnPostMessageCallback = void Function(WebMessage? message, WebUri? sourceOrigin, bool isMainFrame, PlatformJavaScriptReplyProxy replyProxy)
The listener for handling PlatformWebMessageListener events sent by a postMessage() on the injected JavaScript object.
PrintJobCompletionHandler = Future<void> Function(bool completed, String? error)?
A completion handler for the PlatformPrintJobController.
WebAuthenticationSessionCompletionHandler = Future<void> Function(WebUri? url, WebAuthenticationSessionError? error)?
A completion handler for the PlatformWebAuthenticationSession.
WebMessageCallback = void Function(WebMessage? message)
The listener for handling PlatformWebMessagePort events. The message callback methods are called on the main thread.

Exceptions / Errors

ASN1OutOfBufferError
ASN1ParseError