downloadWithProgress method

  1. @override
Stream<int> downloadWithProgress(
  1. String url,
  2. String targetPath, {
  3. String? token,
  4. int maxRetries = 10,
  5. CancelToken? cancelToken,
  6. bool? foreground,
})
override

Downloads a file with progress tracking

Returns a stream of progress percentages (0-100)

Parameters:

  • url: Source URL
  • targetPath: Destination path
  • token: Optional auth token
  • maxRetries: Max retry attempts for transient errors (default: 10) Note: Auth errors (401/403/404) fail after 1 attempt regardless of this value
  • cancelToken: Optional token for cancellation
  • foreground: Android foreground service mode (shows notification, no timeout)
    • null (default): auto-detect based on file size (>500MB = foreground)
    • true: always use foreground
    • false: never use foreground

Throws:

Example:

final cancelToken = CancelToken();
await for (final progress in downloader.downloadWithProgress(..., cancelToken: cancelToken)) {
  print('Progress: $progress%');
}
// Cancel from elsewhere: cancelToken.cancel('User cancelled');

Implementation

@override
Stream<int> downloadWithProgress(
  String url,
  String targetPath, {
  String? token,
  int maxRetries = 10,
  CancelToken? cancelToken,
  bool? foreground,
}) {
  // Delegate to SmartDownloader for all URLs
  // SmartDownloader provides HTTP-aware retry logic for ANY URL
  return SmartDownloader.downloadWithProgress(
    url: url,
    targetPath: targetPath,
    token: token,
    maxRetries: maxRetries,
    cancelToken: cancelToken,
    foreground: foreground,
  );
}