IRestApiClient class abstract

Abstract class to be used as an interface for implementing RestApiClient classes Extends DioMixin so the underlying features of the dio package are also awailable

Inheritance
Implementers

Constructors

IRestApiClient()

Properties

exceptionOptions ↔ BaseExceptionOptions
Defines options for handling exceptions per request Any direct changes to this instances properties are discarded after the response is handled
getter/setter pair
exceptions ↔ StreamController<BaseException>
Provides a way for the user to listen to any RestApiClient exceptions that might happen during the execution of requests
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
httpClientAdapter ↔ HttpClientAdapter
getter/setter pairinherited
interceptors → Interceptors
no setterinherited
jwt → Future<String>
Get jwt from storage
no setter
options ↔ BaseOptions
Default Request config. More see BaseOptions.
getter/setter pairinherited
refreshToken → Future<String>
Get refresh token from storage
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformer ↔ Transformer
transformer allows changes to the request/response data before it is sent/received to/from the server This is only applicable for request methods 'PUT', 'POST', and 'PATCH'.
getter/setter pairinherited

Methods

addAuthorization({required String jwt, required String refreshToken}) → Future<bool>
Method that adds Authorization header and initializes mechanism for managing refresh token logic
clear() → void
Clear the current Dio instance waiting queue.
inherited
close({bool force = false}) → void
Shuts down the dio client.
inherited
delete<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken}) → Future<Response<T>>
Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.
inherited
deleteUri<T>(Uri uri, {dynamic data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>
Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.
inherited
dispose() → Future
Best to call this method to set free allocated resources that the RestApiClient instacte might have allocated
download(String urlPath, dynamic savePath, {ProgressCallback? onReceiveProgress, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, dynamic data, Options? options}) → Future<Response>
Download the file and save it in local. The default http method is 'GET', you can custom it by Options.method.
inherited
downloadUri(Uri uri, dynamic savePath, {ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, dynamic data, Options? options}) → Future<Response>
Download the file and save it in local. The default http method is 'GET', you can custom it by Options.method.
inherited
fetch<T>(RequestOptions requestOptions) → Future<Response<T>>
inherited
get<T>(String path, {Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http GET request, which is a alias of BaseDio.requestOptions.
inherited
getAndCache<T>(String path, {Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http GET request and cache reponse data
getCached<T>(String path, {Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Gets locally saved last response from the path
getUri<T>(Uri uri, {Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http GET request, which is a alias of BaseDio.requestOptions.
inherited
Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.
inherited
headUri<T>(Uri uri, {dynamic data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>
Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.
inherited
init() → Future<IRestApiClient>
Method that initializes RestApiClient instance
isAuthorized() → Future<bool>
Provides information if the current instance of RestApiClient contains Authorization header
lock() → void
Lock the current Dio instance.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http PATCH request, which is a alias of BaseDio.requestOptions.
inherited
patchUri<T>(Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http PATCH request, which is a alias of BaseDio.requestOptions.
inherited
post<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http POST request, which is a alias of BaseDio.requestOptions.
inherited
postAndCache<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http POST request and cache response data
postCached<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Gets locally saved last response from the path
postUri<T>(Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http POST request, which is a alias of BaseDio.requestOptions.
inherited
put<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http PUT request, which is a alias of BaseDio.requestOptions.
inherited
putUri<T>(Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Handy method to make http PUT request, which is a alias of BaseDio.requestOptions.
inherited
removeAuthorization() → Future<bool>
Removes authorization header along with jwt and refreshToken from the secure storage
request<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Make http request with options.
inherited
requestUri<T>(Uri uri, {dynamic data, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Make http request with options.
inherited
setAcceptLanguageHeader(String languageCode) → void
Method that sets appropriate Accept language header
toString() → String
A string representation of this object.
inherited
unlock() → void
Unlock the current Dio instance.
inherited

Operators

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