onDownloadStarting method

  1. @SupportedPlatforms.new(platforms: [AndroidPlatform(apiName: 'WebView.setDownloadListener', apiUrl: '(https://developer.android.com/reference/android/webkit/WebView#setDownloadListener(android.webkit.DownloadListener)'), IOSPlatform(), MacOSPlatform(), WindowsPlatform(apiName: 'ICoreWebView2_4.add_DownloadStarting', apiUrl: 'https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2_4?view=webview2-1.0.2849.39#add_downloadstarting')])
FutureOr<DownloadStartResponse?>? onDownloadStarting(
  1. DownloadStartRequest downloadStartRequest
)

Event fired when WebView recognizes a downloadable file. To download the file, you can use the flutter_downloader plugin.

downloadStartRequest represents the request of the file to download.

NOTE: In order to be able to listen this event, check the InAppWebViewSettings.useOnDownloadStart setting documentation.

Officially Supported Platforms/Implementations:

Parameters - Officially Supported Platforms/Implementations:

  • downloadStartRequest: all platforms

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

Implementation

@SupportedPlatforms(
  platforms: [
    AndroidPlatform(
      apiName: 'WebView.setDownloadListener',
      apiUrl:
          '(https://developer.android.com/reference/android/webkit/WebView#setDownloadListener(android.webkit.DownloadListener)',
    ),
    IOSPlatform(),
    MacOSPlatform(),
    WindowsPlatform(
      apiName: 'ICoreWebView2_4.add_DownloadStarting',
      apiUrl:
          'https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2_4?view=webview2-1.0.2849.39#add_downloadstarting',
    ),
  ],
)
FutureOr<DownloadStartResponse?>? onDownloadStarting(
  DownloadStartRequest downloadStartRequest,
) {
  return null;
}