RestApiClientImpl class

Implemented types

• RestApiClient

Constructors

RestApiClientImpl({required RestApiClientOptions options, ExceptionOptions? exceptionOptions, LoggingOptions? loggingOptions, AuthOptions? authOptions, CacheOptions? cacheOptions, List<Interceptor> interceptors = const []})

Properties

authHandler ↔ AuthHandler

getter/setter pair, override

cacheHandler ↔ CacheHandler

getter/setter pair, override

exceptionHandler ↔ ExceptionHandler

getter/setter pair, override

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addOrUpdateHeader({required String key, required String value}) → void

override

authorize({required String jwt, required String refreshToken}) → Future<bool>

override

clearStorage() → Future

override

delete<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Future<Result<T>>

override

download<T>(String urlPath, dynamic savePath, {dynamic data, Map<String, dynamic>? queryParameters, RestApiClientRequestOptions? options, ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?}) → Future<Result<T>>

override

get<T>(String path, {Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Future<Result<T>>

override

getCached<T>(String path, {Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?}) → Future<Result<T>>

override

getStreamed<T>(String path, {Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Stream<Result<T>>

override

head<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Future<Result<T>>

override

init() → Future<RestApiClient>

override

isAuthorized() → Future<bool>

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Future<Result<T>>

override

post<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options, bool cacheEnabled = false}) → Future<Result<T>>

override

postCached<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?}) → Future<Result<T>>

override

postStreamed<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Stream<Result<T>>

override

put<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, FutureOr<T> onSuccess(dynamic data)?, FutureOr<T> onError(dynamic data)?, RestApiClientRequestOptions? options}) → Future<Result<T>>

override

setAcceptLanguageHeader(String languageCode) → void

override

setContentType(String contentType) → void

override

toString() → String

A string representation of this object.

inherited

unAuthorize() → Future<bool>

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited