PlatformWebViewController class abstract

Interface for a platform implementation of a web view controller.

Platform implementations should extend this class rather than implement it as webview_flutter does not consider newly added methods to be breaking changes. Extending this class (using extends) ensures that the subclass will get the default implementation, while platform implementations that implements this interface will be broken by newly added PlatformWebViewCookieManager methods.

Inheritance
  • Object
  • PlatformInterface
  • PlatformWebViewController

Properties

hashCode → int
The hash code for this object.
no setterinherited
params → PlatformWebViewControllerCreationParams
The parameters used to initialize the PlatformWebViewController.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addJavaScriptChannel(JavaScriptChannelParams javaScriptChannelParams) → Future<void>
Adds a new JavaScript channel to the set of enabled channels.
canGoBack() → Future<bool>
Checks whether there's a back history item.
canGoForward() → Future<bool>
Checks whether there's a forward history item.
clearCache() → Future<void>
Clears all caches used by the WebView.
clearLocalStorage() → Future<void>
Clears the local storage used by the WebView.
currentUrl() → Future<String?>
Accessor to the current URL that the WebView is displaying.
enableDebugging(bool enabled) → Future<void>
Whether to enable the platform's webview content debugging tools.
enableGestureNavigation(bool enabled) → Future<void>
Whether to allow swipe based navigation on supported platforms.
enableZoom(bool enabled) → Future<void>
Whhether to support zooming using its on-screen zoom controls and gestures.
getScrollPosition() → Future<Point<int>>
Return the current scroll position of this view.
getTitle() → Future<String?>
Returns the title of the currently loaded page.
goBack() → Future<void>
Goes back in the history of this WebView.
goForward() → Future<void>
Goes forward in the history of this WebView.
loadFile(String absoluteFilePath) → Future<void>
Loads the file located on the specified absoluteFilePath.
loadFlutterAsset(String key) → Future<void>
Loads the Flutter asset specified in the pubspec.yaml file.
loadHtmlString(String html, {String? baseUrl}) → Future<void>
Loads the supplied HTML string.
loadRequest(LoadRequestParams params) → Future<void>
Makes a specific HTTP request ands loads the response in the webview.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reload() → Future<void>
Reloads the current URL.
removeJavaScriptChannel(String javaScriptChannelName) → Future<void>
Removes the JavaScript channel with the matching name from the set of enabled channels.
runJavaScript(String javaScript) → Future<void>
Runs the given JavaScript in the context of the current page.
runJavaScriptReturningResult(String javaScript) → Future<String>
Runs the given JavaScript in the context of the current page, and returns the result.
scrollBy(int x, int y) → Future<void>
Move the scrolled position of this view.
scrollTo(int x, int y) → Future<void>
Set the scrolled position of this view.
setBackgroundColor(Color color) → Future<void>
Set the current background color of this view.
setJavaScriptMode(JavaScriptMode javaScriptMode) → Future<void>
Sets the JavaScript execution mode to be used by the webview.
setPlatformNavigationDelegate(PlatformNavigationDelegate handler) → Future<void>
Sets the PlatformNavigationDelegate containing the callback methods that are called during navigation events.
setUserAgent(String? userAgent) → Future<void>
Sets the value used for the HTTP User-Agent: request header.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited