Options class
Every request can pass an Options object which will be merged with Dio.options
- Implementers
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 })
Properties
- contentType ↔ dynamic
-
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 setContentType.parse("application/x-www-form-urlencoded")
, and Dio will automatically encode the request body.read / write, inherited -
extra
↔ Map<
String, dynamic> -
Custom field that you can retrieve it later in Interceptor、Transformer and the Response object.
read / write, inherited
- followRedirects ↔ bool
-
see
HttpClientRequest.followRedirects
read / write, inherited - hashCode → int
-
The hash code for this object.
read-only, inherited
-
headers
↔ Map<
String, dynamic> -
Http request headers.
read / write, inherited
- maxRedirects ↔ int
-
Set this property to the maximum number of redirects to follow
when
followRedirects
istrue
. If this number is exceeded an error event will be added with aRedirectException
.read / write, inherited - method ↔ String
-
Http method.
read / write, inherited
- receiveDataWhenStatusError ↔ bool
-
Whether receiving response data when http status code is not successful.
read / write, inherited
- receiveTimeout ↔ int
-
Timeout in milliseconds for receiving data.
Dio will throw the DioError with DioErrorType.RECEIVE_TIMEOUT type
when time out.
read / write, inherited
- requestEncoder ↔ RequestEncoder
-
The default request encoder is utf8encoder, you can set custom
encoder by this option.
read / write, inherited
- responseDecoder ↔ ResponseDecoder
-
The default response decoder is utf8decoder, you can set custom
decoder by this option, it will be used in Transformer.
read / write, inherited
- responseType ↔ ResponseType
-
responseType
indicates the type of data that the server will respond with options which defined in ResponseType arejson
,stream
,plain
.read / write, inherited - 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.SEND_TIMEOUT type
when time out.
read / write, inherited
- validateStatus ↔ ValidateStatus
-
validateStatus
defines whether the request is successful for a given HTTP response status code. IfvalidateStatus
returnstrue
, the request will be perceived as successful; otherwise, considered as failed.read / write, inherited
Methods
-
merge(
{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 }) → 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 -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator.
inherited