NetworkOption class

Constructors

NetworkOption()

factory

Properties

baseUrl ↔ String

Request base url, it can be multiple forms:

getter/setter pair, inherited

connectTimeout ↔ Duration?

Timeout when opening a request.

getter/setter pair, inherited

contentType ↔ String?

getter/setter pair, inherited

errorMsgExtractor ↔ String Function(dynamic error)

a function to extract error as string

getter/setter pair

extra ↔ Map<String, dynamic>

getter/setter pair, inherited

extraSuccessRule ↔ bool Function(NetworkResponse, NetworkRequest)

getter/setter pair

followRedirects ↔ bool

getter/setter pair, inherited

globalCancelToken ↔ CancelToken?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

headers ↔ Map<String, dynamic>

getter/setter pair, inherited

listFormat ↔ ListFormat

getter/setter pair, inherited

maxRedirects ↔ int

getter/setter pair, inherited

method ↔ String

getter/setter pair, inherited

onEndDefault ↔ dynamic Function(NetworkResponse, NetworkRequest)

called on End every request

getter/setter pair

onFailedDefault ↔ void Function(NetworkResponse, NetworkRequest)

called on Failed every request

getter/setter pair

onStartDefault ↔ dynamic Function(NetworkRequest)

called on start every request

getter/setter pair

onSuccessDefault ↔ void Function(NetworkResponse, NetworkRequest)

called on Success every request

getter/setter pair

onTokenExpire ↔ void Function(NetworkResponse, NetworkRequest)

getter/setter pair

option → Options?

no setter

persistentConnection ↔ bool

getter/setter pair, inherited

preserveHeaderCase ↔ bool

getter/setter pair, inherited

queryParameters ↔ Map<String, dynamic>

Common query parameters.

getter/setter pair, inherited

receiveDataWhenStatusError ↔ bool

getter/setter pair, inherited

receiveTimeout ↔ Duration?

getter/setter pair, inherited

requestEncoder ↔ RequestEncoder?

getter/setter pair, inherited

responseDecoder ↔ ResponseDecoder?

getter/setter pair, inherited

responseType ↔ ResponseType

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sendTimeout ↔ Duration?

getter/setter pair, inherited

successMsgExtractor ↔ (String Function(dynamic msg)?)

getter/setter pair

token ↔ String?

String token which is used in header

getter/setter pair

tokenExpireRule ↔ bool Function(NetworkResponse, NetworkRequest)

called on token expire

getter/setter pair

validateStatus ↔ ValidateStatus

getter/setter pair, inherited

Methods

copyWith({String? method, String? baseUrl, Map<String, dynamic>? queryParameters, String? path, Duration? connectTimeout, Duration? receiveTimeout, Duration? sendTimeout, Map<String, Object?>? extra, Map<String, Object?>? headers, bool? preserveHeaderCase, ResponseType? responseType, String? contentType, ValidateStatus? validateStatus, bool? receiveDataWhenStatusError, bool? followRedirects, int? maxRedirects, bool? persistentConnection, RequestEncoder? requestEncoder, ResponseDecoder? responseDecoder, ListFormat? listFormat}) → BaseOptions

Create a BaseOptions from current instance with merged 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

Static Methods

initialize({String? baseUrl, Duration timeout = const Duration(milliseconds: 15000), String? token, bool? followRedirects, void onStartDefault(NetworkRequest)?, void onEndDefault(NetworkResponse, NetworkRequest)?, dynamic onSuccessDefault(NetworkResponse, NetworkRequest)?, dynamic onFailedDefault(NetworkResponse, NetworkRequest)?, CancelToken? globalCancelToken, Map<String, dynamic>? headers, bool tokenExpireRule(NetworkResponse, NetworkRequest)?, bool extraSuccessRule(NetworkResponse, NetworkRequest)?, void onTokenExpire(NetworkResponse, NetworkRequest)?, String errorMsgExtractor(dynamic error)?, String successMsgExtractor(dynamic msg)?}) → dynamic

setAccessToken(String token, {String tokenKey = "Authorization", String tokenPrefix = "Bearer "}) → dynamic