Options class Null safety
Every request can pass an Options object which will be merged with Dio.options
Constructors
-
Options({String? method, int? sendTimeout, int? receiveTimeout, Map<
String, dynamic> ? extra, Map<String, dynamic> ? headers, ResponseType? responseType, String? contentType, ValidateStatus? validateStatus, bool? receiveDataWhenStatusError, bool? followRedirects, int? maxRedirects, RequestEncoder? requestEncoder, ResponseDecoder? responseDecoder, ListFormat? listFormat})
Properties
- contentType ↔ String?
-
The request Content-Type. The default value is ContentType.json.
If you want to encode request body with 'application/x-www-form-urlencoded',
you can set
ContentType.parse('application/x-www-form-urlencoded'), and Dio will automatically encode the request body.read / write -
extra
↔ Map<
String, dynamic> ? -
Custom field that you can retrieve it later in Interceptor、Transformer and the Response object.
read / write
- followRedirects ↔ bool?
-
see HttpClientRequest.followRedirects,
The default value is true
read / write
- hashCode → int
-
The hash code for this object.
read-only, inherited
-
headers
↔ Map<
String, dynamic> ? -
Http request headers. The keys of initial headers will be converted to lowercase,
for example 'Content-Type' will be converted to 'content-type'.
read / write
- listFormat ↔ ListFormat?
-
The listFormat indicates the format of collection data in request
query parameters and
x-www-url-encodedbody data. Possible values defined in ListFormat arecsv,ssv,tsv,pipes,multi,multiCompatible. The default value ismulti.read / write - maxRedirects ↔ int?
-
Set this property to the maximum number of redirects to follow
when followRedirects is
true. If this number is exceeded an error event will be added with aRedirectException.read / write - method ↔ String?
-
Http method.
read / write
- receiveDataWhenStatusError ↔ bool?
-
Whether receiving response data when http status code is not successful.
The default value is true
read / write
- receiveTimeout ↔ int?
-
Timeout in milliseconds for receiving data.
read / write
- requestEncoder ↔ RequestEncoder?
-
The default request encoder is utf8encoder, you can set custom
encoder by this option.
read / write
- responseDecoder ↔ ResponseDecoder?
-
The default response decoder is utf8decoder, you can set custom
decoder by this option, it will be used in Transformer.
read / write
- responseType ↔ ResponseType?
-
responseType indicates the type of data that the server will respond with
options which defined in ResponseType are
json,stream,plain.read / write - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- sendTimeout ↔ int?
-
Timeout in milliseconds for sending data.
Dio will throw the DioError with DioErrorType.sendTimeout type
when time out.
read / write
- validateStatus ↔ ValidateStatus?
-
validateStatusdefines whether the request is successful for a given HTTP response status code. IfvalidateStatusreturnstrue, the request will be perceived as successful; otherwise, considered as failed.read / write
Methods
-
compose(
BaseOptions baseOpt, String path, {dynamic data, Map< String, dynamic> ? queryParameters, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → RequestOptions -
copyWith(
{String? method, int? sendTimeout, int? receiveTimeout, Map< String, dynamic> ? extra, Map<String, dynamic> ? headers, ResponseType? responseType, String? contentType, ValidateStatus? validateStatus, bool? receiveDataWhenStatusError, bool? followRedirects, int? maxRedirects, RequestEncoder? requestEncoder, ResponseDecoder? responseDecoder, ListFormat? listFormat}) → Options - Create a Option from current instance with merging attributes.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited