onLoadResourceWithCustomScheme property

  1. @SupportedPlatforms.new(platforms: [AndroidPlatform(), IOSPlatform(apiName: 'WKURLSchemeHandler', apiUrl: 'https://developer.apple.com/documentation/webkit/wkurlschemehandler'), MacOSPlatform(apiName: 'WKURLSchemeHandler', apiUrl: 'https://developer.apple.com/documentation/webkit/wkurlschemehandler'), WindowsPlatform(), LinuxPlatform(apiName: 'WebKitURISchemeRequest', apiUrl: 'https://wpewebkit.org/reference/stable/wpe-webkit-2.0/class.URISchemeRequest.html')])
FutureOr<CustomSchemeResponse?> Function(T controller, WebResourceRequest request)? onLoadResourceWithCustomScheme
final

Event fired when the WebView finds the custom-scheme while loading a resource. Here you can handle the url request and return a CustomSchemeResponse to load a specific resource encoded to base64.

Officially Supported Platforms/Implementations:

Parameters - Officially Supported Platforms/Implementations:

  • request: all platforms

Use the PlatformWebViewCreationParams.isPropertySupported method to check if this property is supported at runtime.

Implementation

@SupportedPlatforms(
  platforms: [
    AndroidPlatform(),
    IOSPlatform(
      apiName: 'WKURLSchemeHandler',
      apiUrl:
          'https://developer.apple.com/documentation/webkit/wkurlschemehandler',
    ),
    MacOSPlatform(
      apiName: 'WKURLSchemeHandler',
      apiUrl:
          'https://developer.apple.com/documentation/webkit/wkurlschemehandler',
    ),
    WindowsPlatform(),
    LinuxPlatform(
      apiName: 'WebKitURISchemeRequest',
      apiUrl:
          'https://wpewebkit.org/reference/stable/wpe-webkit-2.0/class.URISchemeRequest.html',
    ),
  ],
)
final FutureOr<CustomSchemeResponse?> Function(
  T controller,
  WebResourceRequest request,
)?
onLoadResourceWithCustomScheme;