download<T> abstract method

Future<Result<T>> download<T>(
  1. String urlPath,
  2. dynamic savePath, {
  3. dynamic data,
  4. Map<String, dynamic>? queryParameters,
  5. RestApiClientRequestOptions? options,
  6. ProgressCallback? onReceiveProgress,
  7. CancelToken? cancelToken,
  8. bool deleteOnError = true,
  9. String lengthHeader = Headers.contentLengthHeader,
  10. FutureOr<T> onSuccess(
    1. dynamic data
    )?,
  11. FutureOr<T> onError(
    1. dynamic data
    )?,
})

Downloads a file from the specified urlPath to savePath.

Implementation

Future<Result<T>> download<T>(
  String urlPath,
  savePath, {
  data, // Optional data to send with the request
  Map<String, dynamic>? queryParameters, // Optional query parameters
  RestApiClientRequestOptions? options, // Request options
  ProgressCallback? onReceiveProgress, // Callback for download progress
  CancelToken? cancelToken, // Token to cancel the request
  bool deleteOnError = true, // Deletes the file if an error occurs
  String lengthHeader =
      Headers.contentLengthHeader, // Length header for the request
  FutureOr<T> Function(dynamic data)? onSuccess, // Callback on success
  FutureOr<T> Function(dynamic data)? onError, // Callback on error
});