addUserScripts method

  1. @SupportedPlatforms.new(platforms: [AndroidPlatform(), IOSPlatform(note: "This method will throw an error if the [PlatformWebViewCreationParams.windowId] has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs."), LinuxPlatform(), MacOSPlatform(note: "This method will throw an error if the [PlatformWebViewCreationParams.windowId] has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs."), WebPlatform(), WindowsPlatform()])
Future<void> addUserScripts({
  1. required List<UserScript> userScripts,
})

Injects the userScripts into the webpage’s content.

Officially Supported Platforms/Implementations:

  • Android WebView
  • iOS WKWebView:
    • This method will throw an error if the PlatformWebViewCreationParams.windowId has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs.
  • Linux WPE WebKit
  • macOS WKWebView:
    • This method will throw an error if the PlatformWebViewCreationParams.windowId has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs.
  • Web <iframe> but requires same origin
  • Windows WebView2

Parameters - Officially Supported Platforms/Implementations:

  • userScripts: all platforms

Use the PlatformInAppWebViewController.isMethodSupported method to check if this method is supported at runtime.

Implementation

@SupportedPlatforms(
  platforms: [
    AndroidPlatform(),
    IOSPlatform(
      note:
          "This method will throw an error if the [PlatformWebViewCreationParams.windowId] has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs.",
    ),
    LinuxPlatform(),
    MacOSPlatform(
      note:
          "This method will throw an error if the [PlatformWebViewCreationParams.windowId] has been set. There isn't any way to add/remove user scripts specific to window WebViews. This is a limitation of the native WebKit APIs.",
    ),
    WebPlatform(),
    WindowsPlatform(),
  ],
)
Future<void> addUserScripts({required List<UserScript> userScripts}) {
  throw UnimplementedError(
    '${PlatformInAppWebViewControllerMethod.addUserScripts.name} is not implemented on the current platform',
  );
}