CacheOptions class

Constructors

CacheOptions({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, DioCacheOptions? dioCacheOptions})

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.
getter/setter pairinherited
extra Map<String, dynamic>?
Custom field that you can retrieve it later in InterceptorTransformer and the Response object.
getter/setter pairinherited
followRedirects bool?
see HttpClientRequest.followRedirects, The default value is true
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
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'.
getter/setter pairinherited
listFormat ↔ ListFormat?
The listFormat indicates the format of collection data in request query parameters and x-www-url-encoded body data. Possible values defined in ListFormat are csv, ssv, tsv, pipes, multi, multiCompatible. The default value is multi.
getter/setter pairinherited
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 a RedirectException.
getter/setter pairinherited
method String?
Http method.
getter/setter pairinherited
receiveDataWhenStatusError bool?
Whether receiving response data when http status code is not successful. The default value is true
getter/setter pairinherited
receiveTimeout int?
Timeout in milliseconds for receiving data.
getter/setter pairinherited
requestEncoder ↔ RequestEncoder?
The default request encoder is utf8encoder, you can set custom encoder by this option.
getter/setter pairinherited
responseDecoder ↔ ResponseDecoder?
The default response decoder is utf8decoder, you can set custom decoder by this option, it will be used in Transformer.
getter/setter pairinherited
responseType ↔ ResponseType?
responseType indicates the type of data that the server will respond with options which defined in ResponseType are json, stream, plain.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sendTimeout int?
Timeout in milliseconds for sending data. Dio will throw the DioError with DioErrorType.sendTimeout type when time out.
getter/setter pairinherited
validateStatus ↔ ValidateStatus?
validateStatus defines whether the request is successful for a given HTTP response status code. If validateStatus returns true , the request will be perceived as successful; otherwise, considered as failed.
getter/setter pairinherited

Methods

compose(BaseOptions baseOpt, String path, {dynamic data, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → RequestOptions
inherited
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited