Dio

https://pub.dev/documentation/dio/latest/
Admin
Dio is a powerful HTTP networking package for Dart/Flutter that supports global configuration,...
Tokens:96,210
Snippets:939
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize Dio and perform a simple GET request

Source: https://pub.dev/documentation/dio/latest/index.html

Basic setup for the Dio client and a simple asynchronous GET request.

```dart
import 'package:dio/dio.dart';

final dio = Dio();

void getHttp() async {
  final response = await dio.get('https://dart.dev');
  print(response);
}
```

--------------------------------

### GET https://pub.dev

Source: https://pub.dev/documentation/dio/latest/index.html

Example of performing a GET request and accessing the resulting Response object properties.

```APIDOC
## GET https://pub.dev

### Description
Performs a GET request to the specified URL and returns a Response object containing the server response data, headers, and status information.

### Method
GET

### Endpoint
https://pub.dev

### Response
#### Success Response (200)
- **data** (T?) - The response body, potentially transformed.
- **requestOptions** (RequestOptions) - The corresponding request information.
- **statusCode** (int?) - The HTTP status code.
- **statusMessage** (String?) - The reason phrase associated with the status code.
- **isRedirect** (bool) - Indicates if the response is a redirect.
- **redirects** (List<RedirectRecord>) - The series of redirects followed.
- **extra** (Map<String, dynamic>) - Custom fields associated with the response.
- **headers** (Headers) - The response headers.

### Response Example
```dart
final response = await dio.get('https://pub.dev');
print(response.data);
print(response.headers);
print(response.requestOptions);
print(response.statusCode);
```
```

--------------------------------

### Perform HTTP Request

Source: https://pub.dev/documentation/dio/latest/index.html

Example of calling the request method with path, data, and custom options.

```dart
final response = await dio.request(
  '/test',
  data: {'id': 12, 'name': 'dio'},
  options: Options(method: 'GET'),
);
```

--------------------------------

### Perform GET requests with query parameters

Source: https://pub.dev/documentation/dio/latest/index.html

Demonstrates two ways to pass query parameters: directly in the URL string or via the queryParameters map.

```dart
import 'package:dio/dio.dart';

final dio = Dio();

void request() async {
  Response response;
  response = await dio.get('/test?id=12&name=dio');
  print(response.data.toString());
  // The below request is the same as above.
  response = await dio.get(
    '/test',
    queryParameters: {'id': 12, 'name': 'dio'},
  );
  print(response.data.toString());
}
```

--------------------------------

### Handling a Successful Request

Source: https://pub.dev/documentation/dio/latest/index.html

Demonstrates how to perform a GET request and access common response properties.

```dart
final response = await dio.get('https://pub.dev');
print(response.data);
print(response.headers);
print(response.requestOptions);
print(response.statusCode);
```

--------------------------------

### Get response as a stream

Source: https://pub.dev/documentation/dio/latest/index.html

Configures the request to return the response body as a stream.

```dart
final rs = await dio.get(
  url,
  options: Options(responseType: ResponseType.stream), // Set the response type to `stream`.
);
print(rs.data.stream); // Response stream.
```

--------------------------------

### Get response as bytes

Source: https://pub.dev/documentation/dio/latest/index.html

Configures the request to return the response body as a list of bytes.

```dart
final rs = await Dio().get<List<int>>(
  url,
  options: Options(responseType: ResponseType.bytes), // Set the response type to `bytes`.
);
print(rs.data); // Type: List<int>.
```

--------------------------------

### Configure Dio Instance

Source: https://pub.dev/documentation/dio/latest/index.html

Demonstrates creating a Dio instance with default options, configuring it via BaseOptions, and cloning existing instances.

```dart
final dio = Dio(); // With default `Options`.

void configureDio() {
  // Set default configs
  dio.options.baseUrl = 'https://api.pub.dev';
  dio.options.connectTimeout = Duration(seconds: 5);
  dio.options.receiveTimeout = Duration(seconds: 3);

  // Or create `Dio` with a `BaseOptions` instance.
  final options = BaseOptions(
    baseUrl: 'https://api.pub.dev',
    connectTimeout: Duration(seconds: 5),
    receiveTimeout: Duration(seconds: 3),
  );
  final anotherDio = Dio(options);

  // Or clone the existing `Dio` instance with all fields.
  final clonedDio = dio.clone();
}
```

--------------------------------

### BrowserHttpClientAdapter Constructor

Source: https://pub.dev/documentation/dio/latest/browser/BrowserHttpClientAdapter-class.html

Initializes a new instance of the BrowserHttpClientAdapter.

```APIDOC
## BrowserHttpClientAdapter({bool withCredentials = false, bool enableCORSWarning = true})

### Description
Creates a new BrowserHttpClientAdapter instance for web platforms.

### Parameters
- **withCredentials** (bool) - Optional - Whether to send credentials such as cookies or authorization headers for cross-site requests.
- **enableCORSWarning** (bool) - Optional - Whether to emit a warning log when a request is not a CORS "simple request".
```

--------------------------------

### get<T>

Source: https://pub.dev/documentation/dio/latest/browser/DioForBrowser-class.html

Performs an HTTP GET request.

```APIDOC
## get<T>(String path, {Map<String, dynamic>? queryParameters, Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})

### Description
Convenience method to make an HTTP GET request.

### Parameters
- **path** (String) - Required - The URL path for the request.
- **queryParameters** (Map<String, dynamic>) - Optional - Query parameters to append to the URL.
- **data** (Object) - Optional - Request body data.
- **options** (Options) - Optional - Request configuration options.
- **cancelToken** (CancelToken) - Optional - Token to cancel the request.
- **onReceiveProgress** (ProgressCallback) - Optional - Callback for tracking download progress.
```

--------------------------------

### IOHttpClientAdapter()

Source: https://pub.dev/documentation/dio/latest/io/IOHttpClientAdapter/IOHttpClientAdapter.html

Initializes a new instance of IOHttpClientAdapter with optional configuration for HTTP client creation and certificate validation.

```APIDOC
## IOHttpClientAdapter()

### Description
Initializes a new instance of the IOHttpClientAdapter. This constructor allows users to provide custom logic for creating the underlying HttpClient and validating SSL certificates.

### Parameters
- **onHttpClientCreate** (OnHttpClientCreate) - Optional - @Deprecated: Use createHttpClient instead. This will be removed in 6.0.0.
- **createHttpClient** (CreateHttpClient) - Optional - A callback to create a custom HttpClient instance.
- **validateCertificate** (ValidateCertificate) - Optional - A callback to validate SSL certificates for the connection.
```

--------------------------------

### get<T>(String path, ...)

Source: https://pub.dev/documentation/dio/latest/dio/Dio/get.html

Performs an HTTP GET request to the specified path.

```APIDOC
## get<T>

### Description
Convenience method to make an HTTP GET request.

### Signature
`Future<Response<T>> get<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})`

### Parameters
- **path** (String) - Required - The URL path for the request.
- **data** (Object?) - Optional - The request body data.
- **queryParameters** (Map<String, dynamic>?) - Optional - Query parameters to be appended to the URL.
- **options** (Options?) - Optional - Request configuration options.
- **cancelToken** (CancelToken?) - Optional - Token to cancel the request.
- **onReceiveProgress** (ProgressCallback?) - Optional - Callback to track the progress of receiving data.
```

--------------------------------

### Dio get<T> Method Signature

Source: https://pub.dev/documentation/dio/latest/dio/Dio/get.html

The abstract method signature for performing a GET request in Dio.

```dart
Future<Response<T>> get<T>(
  String path, {
  Object? data,
  Map<String, dynamic>? queryParameters,
  Options? options,
  CancelToken? cancelToken,
  ProgressCallback? onReceiveProgress,
});
```

--------------------------------

### Initialize BrowserHttpClientAdapter

Source: https://pub.dev/documentation/dio/latest/browser/BrowserHttpClientAdapter/BrowserHttpClientAdapter.html

Use this constructor to instantiate the adapter with specific settings for credentials and CORS warnings.

```dart
BrowserHttpClientAdapter({
  this.withCredentials = false,
  this.enableCORSWarning = true,
});
```

--------------------------------

### Handle DioException errors

Source: https://pub.dev/documentation/dio/latest/index.html

Use a try-catch block to handle DioException. Inspect the response property to differentiate between server-side errors and request setup failures.

```dart
try {
  // 404
  await dio.get('https://api.pub.dev/not-exist');
} on DioException catch (e) {
  // The request was made and the server responded with a status code
  // that falls out of the range of 2xx and is also not 304.
  if (e.response != null) {
    print(e.response.data)
    print(e.response.headers)
    print(e.response.requestOptions)
  } else {
    // Something happened in setting up or sending the request that triggered an Error
    print(e.requestOptions)
    print(e.message)
  }
}
```

--------------------------------

### Update get and getUri method signatures

Source: https://pub.dev/documentation/dio/latest/topics/Migration%20Guide-topic.html

The get and getUri methods now include an optional data parameter.

```dart
Future<Response<T>> get<T>(
   String path, {
+  Object? data,
   Map<String, dynamic>? queryParameters,
   Options? options,
   CancelToken? cancelToken,
   ProgressCallback? onReceiveProgress,
 });
```

```dart
Future<Response<T>> getUri<T>(
   Uri uri, {
+  Object? data,
   Map<String, dynamic>? queryParameters,
   Options? options,
   CancelToken? cancelToken,
   ProgressCallback? onReceiveProgress,
 });
```

--------------------------------

### Initialize IOHttpClientAdapter

Source: https://pub.dev/documentation/dio/latest/io/IOHttpClientAdapter/IOHttpClientAdapter.html

Constructs an adapter with optional hooks for creating and configuring the HttpClient.

```dart
IOHttpClientAdapter({
  @Deprecated('Use createHttpClient instead. This will be removed in 6.0.0')
  this.onHttpClientCreate,
  this.createHttpClient,
  this.validateCertificate,
});
```

--------------------------------

### Download with progress tracking and custom headers

Source: https://pub.dev/documentation/dio/latest/browser/DioForBrowser/download.html

Demonstrates tracking download progress and disabling gzip compression via headers.

```dart
await dio.download(
  url,
  (await getTemporaryDirectory()).path + 'flutter.svg',
  options: Options(
    headers: {HttpHeaders.acceptEncodingHeader: '*'}, // Disable gzip
  ),
  onReceiveProgress: (received, total) {
    if (total <= 0) return;
    print('percentage: ${(received / total * 100).toStringAsFixed(0)}%');
  },
);
```

--------------------------------

### Implementation of get<T> in DioMixin

Source: https://pub.dev/documentation/dio/latest/dio/DioMixin/get.html

This method delegates the request to the internal request method with the HTTP method set to 'GET'.

```dart
@override
Future<Response<T>> get<T>(
  String path, {
  Map<String, dynamic>? queryParameters,
  Object? data,
  Options? options,
  CancelToken? cancelToken,
  ProgressCallback? onReceiveProgress,
}) {
  return request<T>(
    path,
    data: data,
    queryParameters: queryParameters,
    options: checkOptions('GET', options),
    onReceiveProgress: onReceiveProgress,
    cancelToken: cancelToken,
  );
}
```

--------------------------------

### LogInterceptor()

Source: https://pub.dev/documentation/dio/latest/dio/LogInterceptor/LogInterceptor.html

Initializes a new LogInterceptor instance with configurable logging options for requests, responses, and errors.

```APIDOC
## LogInterceptor()

### Description
Creates an instance of LogInterceptor to intercept and log Dio network requests and responses.

### Parameters
- **request** (bool) - Optional - Whether to log request information. Defaults to true.
- **requestUrl** (bool) - Optional - Whether to log the request URL. Defaults to true.
- **requestHeader** (bool) - Optional - Whether to log request headers. Defaults to true.
- **requestBody** (bool) - Optional - Whether to log the request body. Defaults to false.
- **responseUrl** (bool) - Optional - Whether to log the response URL. Defaults to true.
- **responseHeader** (bool) - Optional - Whether to log response headers. Defaults to true.
- **responseBody** (bool) - Optional - Whether to log the response body. Defaults to false.
- **error** (bool) - Optional - Whether to log errors. Defaults to true.
- **logPrint** (Function) - Optional - A custom function to handle the log output. Defaults to _debugPrint.
```

--------------------------------

### Dio.get

Source: https://pub.dev/documentation/dio/latest/dio/Dio-class.html

Convenience method to make an HTTP GET request.

```APIDOC
## get<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})

### Description
Convenience method to make an HTTP GET request.

### Parameters
- **path** (String) - Required - The URL path for the request.
- **data** (Object) - Optional - Request body data.
- **queryParameters** (Map<String, dynamic>) - Optional - Query parameters for the request.
- **options** (Options) - Optional - Request configuration options.
- **cancelToken** (CancelToken) - Optional - Token to cancel the request.
- **onReceiveProgress** (ProgressCallback) - Optional - Callback for download progress.
```

--------------------------------

### Get headers property

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/headers.html

Retrieves the current headers map.

```dart
Map<String, dynamic> get headers => _headers;
```

--------------------------------

### Create a Dio instance with BaseOptions

Source: https://pub.dev/documentation/dio/latest/dio/Dio-class.html

Initialize a Dio instance with custom base URL, timeouts, and default headers.

```dart
final dio = Dio(
  BaseOptions(
    baseUrl: "https://pub.dev",
    connectTimeout: const Duration(seconds: 5),
    receiveTimeout: const Duration(seconds: 5),
    headers: {
      HttpHeaders.userAgentHeader: 'dio',
      'common-header': 'xx',
    },
  )
);
```

--------------------------------

### MultipartFile.fromFileSync(String filePath, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/fromFileSync.html

Creates a MultipartFile instance synchronously from a file on the local file system.

```APIDOC
## MultipartFile.fromFileSync

### Description
Creates a `MultipartFile` object synchronously from a specified file path. This is useful for preparing files for multipart/form-data requests in Dio.

### Signature
`static MultipartFile fromFileSync(String filePath, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})`

### Parameters
- **filePath** (String) - Required - The path to the file on the local system.
- **filename** (String?) - Optional - The name of the file to be used in the multipart request.
- **contentType** (DioMediaType?) - Optional - The media type (MIME type) of the file.
- **headers** (Map<String, List<String>>?) - Optional - Additional headers to associate with the file part.
```

--------------------------------

### Get baseUrl implementation

Source: https://pub.dev/documentation/dio/latest/dio/OptionsMixin/baseUrl.html

Retrieves the current base URL string.

```dart
String get baseUrl => _baseUrl;
```

--------------------------------

### Get connectTimeout Implementation

Source: https://pub.dev/documentation/dio/latest/dio/Options/connectTimeout.html

Retrieves the current connection timeout duration.

```dart
Duration? get connectTimeout => _connectTimeout;
```

--------------------------------

### Dio([BaseOptions? options])

Source: https://pub.dev/documentation/dio/latest/dio/Dio/Dio.html

Creates the default Dio instance with the default implementation based on the current platform.

```APIDOC
## Dio Constructor

### Description
Creates the default Dio instance with the default implementation based on different platforms.

### Signature
`Dio([BaseOptions? options])`

### Parameters
- **options** (BaseOptions) - Optional - Configuration options for the Dio instance.
```

--------------------------------

### fetch(RequestOptions, Stream<Uint8List>?, Future<void>?)

Source: https://pub.dev/documentation/dio/latest/dio/HttpClientAdapter/fetch.html

The fetch method is the core entry point for executing HTTP requests when implementing a custom HttpClientAdapter.

```APIDOC
## fetch

### Description
Implement this method to make real HTTP requests. This method is invoked by Dio to execute the network call defined by the provided options.

### Signature
`Future<ResponseBody> fetch(RequestOptions options, Stream<Uint8List>? requestStream, Future<void>? cancelFuture)`

### Parameters
- **options** (RequestOptions) - Required - The configuration for the HTTP request.
- **requestStream** (Stream<Uint8List>?) - Optional - The request body stream. This will not be null when the request body is not empty.
- **cancelFuture** (Future<void>?) - Optional - A future that resolves when the request is canceled. Use this to handle request cancellation.

### Returns
- **Future<ResponseBody>** - A future that resolves to the response body of the HTTP request.
```

--------------------------------

### Get transformTimeout property

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/transformTimeout.html

Retrieves the current transform timeout duration.

```dart
Duration? get transformTimeout => _transformTimeout;
```

--------------------------------

### Get receiveTimeout property

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/receiveTimeout.html

Retrieves the current receive timeout duration.

```dart
Duration? get receiveTimeout => _receiveTimeout;
```

--------------------------------

### HttpClientAdapter()

Source: https://pub.dev/documentation/dio/latest/dio/HttpClientAdapter/HttpClientAdapter.html

Creates a new instance of HttpClientAdapter based on the current platform (IO or Web).

```APIDOC
## HttpClientAdapter()

### Description
Creates a new HttpClientAdapter instance. The implementation automatically selects the appropriate adapter based on the current platform (IO or Web).

### Signature
`factory HttpClientAdapter()`
```

--------------------------------

### Interceptors get interceptors

Source: https://pub.dev/documentation/dio/latest/dio/Dio/interceptors.html

Retrieves the collection of interceptors that have been added to the Dio instance.

```APIDOC
## Interceptors get interceptors

### Description
Returns the list of interceptors currently registered with the Dio instance.

### Signature
`Interceptors get interceptors;`
```

--------------------------------

### MultipartFile Constructors

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile-class.html

This section covers the various ways to create a MultipartFile instance.

```APIDOC
## MultipartFile Constructors

### MultipartFile(Stream<List<int>> stream, int length, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile from a chunked Stream of bytes. The length of the file in bytes must be known in advance. If it's not, read the data from the stream and use MultipartFile.fromBytes instead.

### MultipartFile.fromBytes(List<int> value, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile from a byte array.

### MultipartFile.fromStream(Stream<List<int>> data(), int length, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile from a creation method that creates chunked Stream of bytes. The length of the file in bytes must be known in advance. If it's not, read the data from the stream and use MultipartFile.fromBytes instead.

### MultipartFile.fromString(String value, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile from a string.
```

--------------------------------

### Dio(BaseOptions? options)

Source: https://pub.dev/documentation/dio/latest/dio/Dio-class.html

Creates a new Dio instance. You can optionally provide BaseOptions to configure the base URL, timeouts, and default headers.

```APIDOC
## Dio Constructor

### Description
Creates the default Dio instance with the default implementation based on the platform.

### Signature
`Dio([BaseOptions? options])`

### Example
```dart
final dio = Dio(
  BaseOptions(
    baseUrl: "https://pub.dev",
    connectTimeout: const Duration(seconds: 5),
    receiveTimeout: const Duration(seconds: 5),
  )
);
```
```

--------------------------------

### bool get isFinalized

Source: https://pub.dev/documentation/dio/latest/dio/FormData/isFinalized.html

A getter that returns true if the FormData has been finalized, otherwise false.

```APIDOC
## bool get isFinalized

### Description
Returns a boolean value indicating whether the `finalize` method has been called on the `FormData` instance.

### Signature
`bool get isFinalized`

### Returns
- **bool**: `true` if finalized, `false` otherwise.
```

--------------------------------

### HttpClientAdapter Class Overview

Source: https://pub.dev/documentation/dio/latest/dio/HttpClientAdapter-class.html

Provides an abstract overview of the HttpClientAdapter class, its purpose, and how it integrates with Dio.

```APIDOC
## HttpClientAdapter Class

`HttpAdapter` is a bridge between Dio and HttpClient. Dio implements standard and friendly API for developer. HttpClient is the real object that makes Http requests. We can use any HttpClients not just "dart:io:HttpClient" to make the HTTP request. All we need is to provide a HttpClientAdapter. If you want to customize the HttpClientAdapter you should instead use either IOHttpClientAdapter on `dart:io` platforms or BrowserHttpClientAdapter on `dart:html` platforms.

### Implementers
* IOHttpClientAdapter
```

--------------------------------

### bool get isCompleted

Source: https://pub.dev/documentation/dio/latest/dio/ErrorInterceptorHandler/isCompleted.html

Returns a boolean value indicating if the handler has finished its execution.

```APIDOC
## bool get isCompleted

### Description
Returns true if the ErrorInterceptorHandler has been completed, otherwise returns false.

### Signature
`bool get isCompleted`

### Returns
- **bool** - The completion status of the handler.
```

--------------------------------

### bool get isCancelled

Source: https://pub.dev/documentation/dio/latest/dio/CancelToken/isCancelled.html

Returns true if the token has been cancelled, otherwise returns false.

```APIDOC
## bool get isCancelled

### Description
Checks whether the current CancelToken has been cancelled. This property returns true if a cancellation error has been associated with the token.

### Return Value
- **bool** - Returns true if the token is cancelled, false otherwise.
```

--------------------------------

### Options Constructor

Source: https://pub.dev/documentation/dio/latest/dio/Options-class.html

Creates a new Options instance to configure request parameters.

```APIDOC
## Options({String? method, Duration? sendTimeout, Duration? receiveTimeout, Duration? transformTimeout, Duration? connectTimeout, Map<String, dynamic>? extra, Map<String, dynamic>? headers, bool? preserveHeaderCase, ResponseType? responseType, String? contentType, ValidateStatus? validateStatus, bool? receiveDataWhenStatusError, bool? followRedirects, int? maxRedirects, bool? persistentConnection, RequestEncoder? requestEncoder, ResponseDecoder? responseDecoder, ListFormat? listFormat})

### Description
Initializes a new configuration object for a Dio request.

### Parameters
- **method** (String?) - Optional - The HTTP request method.
- **sendTimeout** (Duration?) - Optional - Timeout when sending data.
- **receiveTimeout** (Duration?) - Optional - Timeout when receiving data.
- **connectTimeout** (Duration?) - Optional - Timeout when opening a request.
- **headers** (Map<String, dynamic>?) - Optional - HTTP request headers.
- **contentType** (String?) - Optional - The request content-type.
```

--------------------------------

### Get sendTimeout property

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/sendTimeout.html

Retrieves the current timeout duration set for sending requests.

```dart
Duration? get sendTimeout => _sendTimeout;
```

--------------------------------

### BaseOptions Constructor

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/BaseOptions.html

Initializes a new instance of BaseOptions with configurable request parameters.

```APIDOC
## BaseOptions Constructor

### Description
Creates a configuration object for Dio requests. This object holds default values for request properties like timeouts, headers, and base URLs.

### Signature
BaseOptions({
  String? method,
  Duration? connectTimeout,
  Duration? receiveTimeout,
  Duration? sendTimeout,
  Duration? transformTimeout,
  String baseUrl = '',
  Map<String, dynamic>? queryParameters,
  Map<String, dynamic>? extra,
  Map<String, dynamic>? headers,
  bool? preserveHeaderCase = false,
  ResponseType? responseType = ResponseType.json,
  String? contentType,
  ValidateStatus? validateStatus,
  bool? receiveDataWhenStatusError,
  bool? followRedirects,
  int? maxRedirects,
  bool? persistentConnection,
  RequestEncoder? requestEncoder,
  ResponseDecoder? responseDecoder,
  ListFormat? listFormat
})
```

--------------------------------

### Get contentType implementation

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/contentType.html

Retrieves the current Content-Type header value from the headers map.

```dart
String? get contentType => _headers[Headers.contentTypeHeader] as String?;
```

--------------------------------

### Configure Proxy with IOHttpClientAdapter

Source: https://pub.dev/documentation/dio/latest/index.html

Uses the createHttpClient callback to configure a proxy for native platform requests.

```dart
import 'package:dio/io.dart';

void initAdapter() {
  dio.httpClientAdapter = IOHttpClientAdapter(
    createHttpClient: () {
      final client = HttpClient();
      // Config the client.
      client.findProxy = (uri) {
        // Forward all request to proxy "localhost:8888".
        // Be aware, the proxy should went through you running device,
        // not the host platform.
        return 'PROXY localhost:8888';
      };
      // You can also create a new HttpClient for Dio instead of returning,
      // but a client must being returned here.
      return client;
    },
  );
}
```

--------------------------------

### MultipartFile.fromBytes Implementation

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/MultipartFile.fromBytes.html

The factory constructor initializes a MultipartFile by wrapping the byte list into a stream.

```dart
factory MultipartFile.fromBytes(
  List<int> value, {
  String? filename,
  DioMediaType? contentType,
  final Map<String, List<String>>? headers,
}) {
  return MultipartFile.fromStream(
    () => Stream.fromIterable([value]),
    value.length,
    filename: filename,
    contentType: contentType,
    headers: headers,
  );
}
```

--------------------------------

### Create HttpClientAdapter

Source: https://pub.dev/documentation/dio/latest/dio/HttpClientAdapter/HttpClientAdapter.html

Instantiates an adapter suitable for the current platform environment.

```dart
factory HttpClientAdapter() => adapter.createAdapter();
```

--------------------------------

### MultipartFile Static Methods

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile-class.html

This section covers static methods for creating MultipartFile instances from files.

```APIDOC
## MultipartFile Static Methods

### MultipartFile.fromFile(String filePath, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile from a path to a file on disk.

### MultipartFile.fromFileSync(String filePath, {String? filename, DioMediaType? contentType, Map<String, List<String>>? headers})

**Description**: Creates a new MultipartFile synchronously from a path to a file on disk.

### MultipartFile.lookupMediaType(String? filenameOrPath)

**Description**: Lookup the media type from the given `filenameOrPath` based on its extension.
```

--------------------------------

### bool get isEmpty

Source: https://pub.dev/documentation/dio/latest/dio/Headers/isEmpty.html

Returns true if the headers map contains no fields, otherwise returns false.

```APIDOC
## bool get isEmpty

### Description
Checks whether the headers object has no fields.

### Returns
- **bool** - Returns true if the headers are empty, false otherwise.
```

--------------------------------

### Response<T> constructor

Source: https://pub.dev/documentation/dio/latest/dio/Response/Response.html

Initializes a new instance of the Response class with the provided response data and metadata.

```APIDOC
## Response<T> constructor

### Description
Creates a new Response object containing the result of an HTTP request.

### Parameters
- **data** (T?) - Optional - The response body data.
- **requestOptions** (RequestOptions) - Required - The configuration used for the request.
- **statusCode** (int?) - Optional - The HTTP status code.
- **statusMessage** (String?) - Optional - The HTTP status message.
- **isRedirect** (bool) - Optional - Whether the response is a redirect (default: false).
- **redirects** (List<RedirectRecord>) - Optional - A list of redirect records.
- **extra** (Map<String, dynamic>?) - Optional - Extra metadata associated with the response.
- **headers** (Headers?) - Optional - The response headers.
```

--------------------------------

### MultipartFile.fromString Implementation

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/MultipartFile.fromString.html

The internal implementation of the factory constructor, showing how it resolves media types and encodes the string value into bytes.

```dart
factory MultipartFile.fromString(
  String value, {
  String? filename,
  DioMediaType? contentType,
  final Map<String, List<String>>? headers,
}) {
  contentType ??= lookupMediaType(filename) ?? DioMediaType('text', 'plain');
  final encoding = encodingForCharset(
    contentType.parameters['charset'],
    utf8,
  );
  contentType = contentType.change(parameters: {'charset': encoding.name});
  return MultipartFile.fromBytes(
    encoding.encode(value),
    filename: filename,
    contentType: contentType,
    headers: headers,
  );
}
```

--------------------------------

### getUri<T> method

Source: https://pub.dev/documentation/dio/latest/dio/Dio/getUri.html

Performs an HTTP GET request using the provided Uri and optional configuration parameters.

```APIDOC
## getUri<T>

### Description
Convenience method to make an HTTP GET request with a Uri object.

### Signature
`Future<Response<T>> getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})`

### Parameters
- **uri** (Uri) - Required - The target URI for the GET request.
- **data** (Object?) - Optional - Data to be sent with the request.
- **options** (Options?) - Optional - Request configuration options.
- **cancelToken** (CancelToken?) - Optional - Token to cancel the request.
- **onReceiveProgress** (ProgressCallback?) - Optional - Callback to track the progress of receiving data.
```

--------------------------------

### Dio getUri Method Signature

Source: https://pub.dev/documentation/dio/latest/dio/Dio/getUri.html

The abstract method definition for performing a GET request using a Uri.

```dart
Future<Response<T>> getUri<T>(
  Uri uri, {
  Object? data,
  Options? options,
  CancelToken? cancelToken,
  ProgressCallback? onReceiveProgress,
});
```

--------------------------------

### IOHttpClientAdapter Class

Source: https://pub.dev/documentation/dio/latest/io

The default HttpClientAdapter for native platforms.

```APIDOC
## IOHttpClientAdapter

### Description
The default HttpClientAdapter for native platforms.

### Class
IOHttpClientAdapter
```

--------------------------------

### transformTimeout

Source: https://pub.dev/documentation/dio/latest/dio/RequestOptions/transformTimeout.html

A property to get or set the timeout duration for request transformations. Setting a negative duration will throw a StateError.

```APIDOC
## transformTimeout

### Description
Gets or sets the timeout duration for request transformations. If a negative duration is provided during the setter, a StateError is thrown.

### Signature
- **Getter**: `Duration? get transformTimeout`
- **Setter**: `set transformTimeout(Duration? value)`

### Parameters
- **value** (Duration?) - The duration to set for the transformation timeout. Must be non-negative.
```

--------------------------------

### bool get isFinalized

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/isFinalized.html

A boolean property that returns true if the finalize method has been invoked for the MultipartFile, otherwise false.

```APIDOC
## bool get isFinalized

### Description
Returns a boolean value indicating whether the `finalize` method has been called on the `MultipartFile` instance.

### Signature
`bool get isFinalized`

### Returns
- **bool**: `true` if finalized, `false` otherwise.
```

--------------------------------

### MultipartFile.fromFile Implementation

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/fromFile.html

The internal implementation of the fromFile static method using multipartFileFromPath.

```dart
static Future<MultipartFile> fromFile(
  String filePath, {
  String? filename,
  DioMediaType? contentType,
  final Map<String, List<String>>? headers,
}) {
  return multipartFileFromPath(
    filePath,
    filename: filename,
    contentType: contentType,
    headers: headers,
  );
}
```

--------------------------------

### Dynamic invocation error example

Source: https://pub.dev/documentation/dio/latest/dio/OptionsMixin/noSuchMethod.html

Demonstrates a run-time error caused by calling a non-existent method on a dynamic object.

```dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error
```

--------------------------------

### QueuedInterceptor Constructors and Properties

Source: https://pub.dev/documentation/dio/latest/dio/QueuedInterceptor-class.html

Details the constructors and properties available for the QueuedInterceptor class.

```APIDOC
## Constructors 

QueuedInterceptor()
    
## Properties 

hashCode → int 
     The hash code for this object. 
no setterinherited 

runtimeType → Type 
     A representation of the runtime type of the object. 
no setterinherited
```

--------------------------------

### IOHttpClientAdapter Constructors

Source: https://pub.dev/documentation/dio/latest/io/IOHttpClientAdapter-class.html

Details about the constructors available for the IOHttpClientAdapter class.

```APIDOC
## Constructors

IOHttpClientAdapter({@Deprecated('Use createHttpClient instead. This will be removed in 6.0.0') OnHttpClientCreate? onHttpClientCreate, CreateHttpClient? createHttpClient, ValidateCertificate? validateCertificate})

### Description

Initializes a new instance of the IOHttpClientAdapter class.

### Parameters

- **onHttpClientCreate** (OnHttpClientCreate?) - Optional - Dio will create HttpClient when it is needed. If onHttpClientCreate has provided, Dio will call it when a HttpClient created. Deprecated: Use createHttpClient instead. This will be removed in 6.0.0.
- **createHttpClient** (CreateHttpClient?) - Optional - When this callback is set, Dio will call it every time it needs a HttpClient.
- **validateCertificate** (ValidateCertificate?) - Optional - Allows the user to decide if the response certificate is good. If this function is missing, then the certificate is allowed. This method is called only if both the SecurityContext and `badCertificateCallback` accept the certificate chain. Those methods evaluate the root or intermediate certificate, while validateCertificate evaluates the leaf certificate.
```

--------------------------------

### int get contentLength

Source: https://pub.dev/documentation/dio/latest/dio/ResponseBody/contentLength.html

Retrieves the content length of the response body from the headers. Returns -1 if the content length is not specified.

```APIDOC
## int get contentLength

### Description
Returns the content length of the response body as an integer. If the content length header is missing or not specified, it returns -1.

### Return Value
- **int** - The length of the response body in bytes, or -1.
```

--------------------------------

### HttpClientAdapter Constructors

Source: https://pub.dev/documentation/dio/latest/dio/HttpClientAdapter-class.html

Details on the constructors available for the HttpClientAdapter class.

```APIDOC
## Constructors

### HttpClientAdapter()
     Create a HttpClientAdapter based on the current platform (IO/Web).
     `factory`
```

--------------------------------

### Implementation of getUri in DioMixin

Source: https://pub.dev/documentation/dio/latest/dio/DioMixin/getUri.html

This method wraps the requestUri call, automatically setting the HTTP method to 'GET' via checkOptions.

```dart
@override
Future<Response<T>> getUri<T>(
  Uri uri, {
  Object? data,
  Options? options,
  CancelToken? cancelToken,
  ProgressCallback? onReceiveProgress,
}) {
  return requestUri<T>(
    uri,
    data: data,
    options: checkOptions('GET', options),
    onReceiveProgress: onReceiveProgress,
    cancelToken: cancelToken,
  );
}
```

--------------------------------

### OnHttpClientCreate Typedef

Source: https://pub.dev/documentation/dio/latest/io

Signature for customizing HttpClient creation.

```APIDOC
## OnHttpClientCreate

### Description
The signature of IOHttpClientAdapter.onHttpClientCreate. Allows for custom HttpClient creation logic.

### Typedef
OnHttpClientCreate = HttpClient? Function(HttpClient client)
```

--------------------------------

### Dynamic save path resolution

Source: https://pub.dev/documentation/dio/latest/browser/DioForBrowser/download.html

Example of using a function to resolve the save path dynamically based on response headers.

```dart
await dio.download(
  url,
  (Headers headers) {
    // Extra info: redirect counts
    print(headers.value('redirects'));
    // Extra info: real uri
    print(headers.value('uri'));
    // ...
    return (await getTemporaryDirectory()).path + 'file_name';
  },
);
```

--------------------------------

### RequestOptions Constructor

Source: https://pub.dev/documentation/dio/latest/dio/RequestOptions/RequestOptions.html

Initializes a new instance of RequestOptions with configurable request settings.

```APIDOC
## RequestOptions Constructor

### Description
Creates a configuration object for Dio requests, allowing customization of path, data, timeouts, headers, and other request-specific settings.

### Parameters
- **path** (String) - Optional - The request path.
- **data** (dynamic) - Optional - The request body data.
- **onReceiveProgress** (ProgressCallback) - Optional - Callback for receive progress.
- **onSendProgress** (ProgressCallback) - Optional - Callback for send progress.
- **cancelToken** (CancelToken) - Optional - Token to cancel the request.
- **method** (String) - Optional - The HTTP method.
- **sendTimeout** (Duration) - Optional - Timeout for sending data.
- **receiveTimeout** (Duration) - Optional - Timeout for receiving data.
- **transformTimeout** (Duration) - Optional - Timeout for data transformation.
- **connectTimeout** (Duration) - Optional - Timeout for establishing connection.
- **queryParameters** (Map<String, dynamic>) - Optional - Query parameters for the request.
- **baseUrl** (String) - Optional - The base URL for the request.
- **extra** (Map<String, dynamic>) - Optional - Extra configuration data.
- **headers** (Map<String, dynamic>) - Optional - HTTP headers.
- **preserveHeaderCase** (bool) - Optional - Whether to preserve header case.
- **responseType** (ResponseType) - Optional - The expected response type.
- **contentType** (String) - Optional - The content type of the request.
- **validateStatus** (ValidateStatus) - Optional - Function to validate the response status.
- **receiveDataWhenStatusError** (bool) - Optional - Whether to receive data on status error.
- **followRedirects** (bool) - Optional - Whether to follow redirects.
- **maxRedirects** (int) - Optional - Maximum number of redirects.
- **persistentConnection** (bool) - Optional - Whether to use persistent connection.
- **requestEncoder** (RequestEncoder) - Optional - Custom request encoder.
- **responseDecoder** (ResponseDecoder) - Optional - Custom response decoder.
- **listFormat** (ListFormat) - Optional - Format for lists in query parameters.
- **setRequestContentTypeWhenNoPayload** (bool) - Optional - Whether to set content type when no payload exists.
- **sourceStackTrace** (StackTrace) - Optional - The stack trace for the request.
```

--------------------------------

### method property

Source: https://pub.dev/documentation/dio/latest/dio/Options/method.html

The method property is a getter/setter pair used to specify the HTTP request method (e.g., GET, POST) for a Dio request.

```APIDOC
## method property

### Description
The method property represents the HTTP request method for a Dio request. It is a getter/setter pair that accepts a String value.

### Signature
String? method;
```

--------------------------------

### MultipartFile Methods

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile-class.html

Available methods for interacting with a MultipartFile instance.

```APIDOC
## MultipartFile Methods

### clone() → MultipartFile

**Description**: Clone MultipartFile, returning a new instance of the same object. This is useful if your request failed and you wish to retry it, such as an unauthorized exception can be solved by refreshing the token.

### finalize() → Stream<Uint8List>

**Description**: Finalizes the multipart file stream.
```

--------------------------------

### Clone MultipartFile

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile-class.html

Clones the MultipartFile instance. This is useful for retrying failed requests, for example, if an unauthorized exception occurs and the token needs to be refreshed.

```dart
clone() → MultipartFile
```

--------------------------------

### getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})

Source: https://pub.dev/documentation/dio/latest/dio/DioMixin/getUri.html

Makes an HTTP GET request to the specified Uri.

```APIDOC
## getUri<T>

### Description
Convenience method to make an HTTP GET request with a Uri object.

### Signature
`Future<Response<T>> getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress})`

### Parameters
- **uri** (Uri) - Required - The target URI for the GET request.
- **data** (Object?) - Optional - Data to be sent with the request.
- **options** (Options?) - Optional - Request configuration options.
- **cancelToken** (CancelToken?) - Optional - Token to cancel the request.
- **onReceiveProgress** (ProgressCallback?) - Optional - Callback to track the progress of data reception.
```

--------------------------------

### QueuedInterceptor Methods

Source: https://pub.dev/documentation/dio/latest/dio/QueuedInterceptor-class.html

Lists the methods available for the QueuedInterceptor class, including request, response, and error handling.

```APIDOC
## Methods 

noSuchMethod(Invocation invocation) → dynamic 
     Invoked when a nonexistent method or property is accessed. 
inherited 

onError(DioException err, ErrorInterceptorHandler handler) → void 
     Called when an exception was occurred during the request. 
inherited 

onRequest(RequestOptions options, RequestInterceptorHandler handler) → void 
     Called when the request is about to be sent. 
inherited 

onResponse(Response response, ResponseInterceptorHandler handler) → void 
     Called when the response is about to be resolved. 
inherited 

toString() → String 
     A string representation of this object. 
inherited
```

--------------------------------

### Download method implementation

Source: https://pub.dev/documentation/dio/latest/dio/DioMixin/download.html

The base implementation signature for the download method within the DioMixin.

```dart
@override
Future<Response> download(
  String urlPath,
  dynamic savePath, {
  ProgressCallback? onReceiveProgress,
  Map<String, dynamic>? queryParameters,
  CancelToken? cancelToken,
  bool deleteOnError = true,
  FileAccessMode fileAccessMode = FileAccessMode.write,
  String lengthHeader = Headers.contentLengthHeader,
  Object? data,
  Options? options,
}) {
  throw UnimplementedError();
}
```

--------------------------------

### MultipartFile.fromStream Implementation

Source: https://pub.dev/documentation/dio/latest/dio/MultipartFile/MultipartFile.fromStream.html

The internal implementation of the MultipartFile.fromStream constructor.

```dart
MultipartFile.fromStream(
  Stream<List<int>> Function() data,
  this.length, {
  this.filename,
  DioMediaType? contentType,
  Map<String, List<String>>? headers,
})  : _dataBuilder = data,
      headers = caseInsensitiveKeyMap(headers),
      contentType = contentType ??
          lookupMediaType(filename) ??
          DioMediaType('application', 'octet-stream');
```

--------------------------------

### Uri get realUri

Source: https://pub.dev/documentation/dio/latest/dio/Response/realUri.html

Retrieves the final request URI. If redirects occurred, it returns the location of the last redirect; otherwise, it returns the original request URI.

```APIDOC
## Uri get realUri

### Description
Returns the final request URI after all redirects have been processed. Note that the availability of this property depends on the underlying adapter support.

### Signature
`Uri get realUri`

### Returns
- **Uri** - The final URI of the request.
```

--------------------------------

### Initialize Dio Options

Source: https://pub.dev/documentation/dio/latest/dio/Options/Options.html

The constructor accepts various parameters to configure request behavior, including timeouts and headers. It includes assertions to ensure that timeout durations are not negative.

```dart
Options({
  this.method,
  Duration? sendTimeout,
  Duration? receiveTimeout,
  Duration? transformTimeout,
  Duration? connectTimeout,
  this.extra,
  this.headers,
  this.preserveHeaderCase,
  this.responseType,
  this.contentType,
  this.validateStatus,
  this.receiveDataWhenStatusError,
  this.followRedirects,
  this.maxRedirects,
  this.persistentConnection,
  this.requestEncoder,
  this.responseDecoder,
  this.listFormat,
})  : assert(receiveTimeout == null || !receiveTimeout.isNegative),
      _receiveTimeout = receiveTimeout,
      assert(sendTimeout == null || !sendTimeout.isNegative),
      _sendTimeout = sendTimeout,
      assert(transformTimeout == null || !transformTimeout.isNegative),
      _transformTimeout = transformTimeout,
      assert(connectTimeout == null || !connectTimeout.isNegative),
      _connectTimeout = connectTimeout;
```

--------------------------------

### Uri get uri

Source: https://pub.dev/documentation/dio/latest/dio/RequestOptions/uri.html

The uri getter generates the complete requesting Uri by combining the baseUrl and path, appending query parameters, and normalizing the resulting string.

```APIDOC
## Uri get uri

### Description
Generates the requesting Uri from the current RequestOptions. It combines the base URL and path, encodes query parameters, and returns a normalized Uri object.

### Signature
`Uri get uri`

### Returns
- **Uri** - The fully constructed and normalized Uri object.
```

--------------------------------

### QueuedInterceptor Constructor

Source: https://pub.dev/documentation/dio/latest/dio/QueuedInterceptor/QueuedInterceptor.html

Initializes a new instance of the QueuedInterceptor class.

```APIDOC
## QueuedInterceptor()

### Description
Initializes a new instance of the QueuedInterceptor class.

### Method
Constructor

### Endpoint
N/A

### Parameters
This constructor does not accept any parameters.

### Request Example
```json
{
  "example": "QueuedInterceptor()"
}
```

### Response
#### Success Response (200)
N/A (Constructors do not return values in the traditional sense).

#### Response Example
N/A
```

--------------------------------

### Duration? receiveTimeout

Source: https://pub.dev/documentation/dio/latest/dio/BaseOptions/receiveTimeout.html

The receiveTimeout property allows setting or getting the duration for which the client will wait to receive data from the server. If the duration is exceeded, a timeout error is thrown.

```APIDOC
## Property: receiveTimeout

### Description
Gets or sets the timeout duration for receiving data from the server. If the value is set to a negative duration, a StateError will be thrown.

### Signature
- **Getter**: `Duration? get receiveTimeout`
- **Setter**: `set receiveTimeout(Duration? value)`

### Parameters
- **value** (Duration?) - The duration to wait for receiving data. Must be positive if provided.
```

--------------------------------

### QueuedInterceptor Class Overview

Source: https://pub.dev/documentation/dio/latest/dio/QueuedInterceptor-class.html

Provides an overview of the QueuedInterceptor class, its purpose, and inheritance.

```APIDOC
## QueuedInterceptor Class

Interceptor in queue.
`onRequest`, `onResponse`, and `onError` are processed in separate queues when running concurrent requests. These queues run in parallel, new requests can be initiated before previous have been completed.

### Inheritance
    
  * Object
  * Interceptor
  * QueuedInterceptor

### Implementers
    
  * QueuedInterceptorsWrapper
```

--------------------------------

### int get length

Source: https://pub.dev/documentation/dio/latest/dio/FormData/length.html

Returns the total length of the request body in bytes. This value is automatically calculated from the fields and files added to the FormData instance and cannot be set manually.

```APIDOC
## int get length

### Description
Returns the total length of the request body, in bytes. This value is calculated automatically based on the fields and files contained within the FormData object.

### Return Value
- **int** - The total size of the request body in bytes.
```

--------------------------------

### IOHttpClientAdapter Methods

Source: https://pub.dev/documentation/dio/latest/io/IOHttpClientAdapter-class.html

Details about the methods available for the IOHttpClientAdapter class.

```APIDOC
## Methods

### close

- **Signature**: close({bool force = false}) → void
- **Description**: Close the current adapter and its inner clients or requests.
- **Override**: true
- **Parameters**:
  - **force** (bool) - Optional - Defaults to false. Indicates if the closing should be forceful.

### fetch

- **Signature**: fetch(RequestOptions options, Stream<Uint8List>? requestStream, Future<void>? cancelFuture) → Future<ResponseBody>
- **Description**: Implement this method to make real HTTP requests.
- **Override**: true
- **Parameters**:
  - **options** (RequestOptions) - Required - The request options.
  - **requestStream** (Stream<Uint8List>?) - Optional - The stream for the request body.
  - **cancelFuture** (Future<void>?) - Optional - A future that can be used to cancel the request.

### noSuchMethod

- **Signature**: noSuchMethod(Invocation invocation) → dynamic
- **Description**: Invoked when a nonexistent method or property is accessed.
- **Inherited**: true
```

--------------------------------

### Future<Response> downloadUri(Uri uri, dynamic savePath, ...)

Source: https://pub.dev/documentation/dio/latest/dio/Dio/downloadUri.html

Downloads a file from the provided URI and saves it to the specified path. The default HTTP method is GET, which can be overridden via Options.

```APIDOC
## Method: downloadUri

### Description
Downloads a file from the provided `Uri` and saves it to the local file system or triggers a browser download on Web platforms.

### Signature
`Future<Response> downloadUri(Uri uri, dynamic savePath, {ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, FileAccessMode fileAccessMode = FileAccessMode.write, String lengthHeader = Headers.contentLengthHeader, Object? data, Options? options})`

### Parameters
- **uri** (Uri) - Required - The source URI of the file to download.
- **savePath** (dynamic) - Required - The destination path. Can be a `String` (file path) or a `FutureOr<String> Function(Headers headers)`.
- **onReceiveProgress** (ProgressCallback?) - Optional - Callback to monitor download progress.
- **cancelToken** (CancelToken?) - Optional - Token to cancel the request.
- **deleteOnError** (bool) - Optional - Whether to delete the file if an error occurs. Defaults to `true`.
- **fileAccessMode** (FileAccessMode) - Optional - Mode for file access. Defaults to `FileAccessMode.write`.
- **lengthHeader** (String) - Optional - Header used to determine file size for progress tracking. Defaults to `Headers.contentLengthHeader`.
- **data** (Object?) - Optional - Request body data.
- **options** (Options?) - Optional - Custom request options, including HTTP method overrides.
```
Tokens:
Raw