FlutterNetworkClient class

Main Flutter Network Client (Facade Pattern) This is the main interface users will interact with

Constructors

FlutterNetworkClient({required String baseUrl, Map<String, String>? defaultHeaders, Duration? defaultTimeout, int? maxRetries, List<int>? retryStatusCodes, bool enableRequestLogging = false, bool enableResponseLogging = false, bool rethrowExceptions = false, TokenProvider? tokenProvider, RefreshTokenProvider? refreshTokenProvider, TokenRefresher? tokenRefresher, TokenConfig? tokenConfig})

Factory constructor with builder pattern

factory

FlutterNetworkClient.withCustomTokens({required String baseUrl, Map<String, String>? defaultHeaders, Duration? defaultTimeout, int? maxRetries, List<int>? retryStatusCodes, bool enableRequestLogging = false, bool enableResponseLogging = false, bool rethrowExceptions = false, required Future<String?> getToken(), Future<String?> getRefreshToken()?, Future<String?> refreshToken()?, TokenConfig? tokenConfig})

Factory constructor with custom token providers

factory

FlutterNetworkClient.withTokens({required String baseUrl, Map<String, String>? defaultHeaders, Duration? defaultTimeout, int? maxRetries, List<int>? retryStatusCodes, bool enableRequestLogging = false, bool enableResponseLogging = false, bool rethrowExceptions = false, TokenConfig? tokenConfig, Future<String?> customRefreshHandler()?})

Factory constructor with token management

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

delete<T>(String path, {Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

DELETE request

dispose() → void

Dispose resources

get<T>(String path, {Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

GET request

head(String path, {Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken}) → Future<HttpResponse<Map<String, String>>>

HEAD request

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch<T>(String path, {dynamic body, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

PATCH request

post<T>(String path, {dynamic body, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

POST request

put<T>(String path, {dynamic body, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

PUT request

request<T>(HttpMethod method, String path, {dynamic body, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

Custom request

toString() → String

A string representation of this object.

inherited

uploadFile<T>(String path, MultipartFile file, {Map<String, String>? fields, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

Upload a single file

uploadFiles<T>(String path, List<MultipartFile> files, {Map<String, String>? fields, Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

Upload multiple files

uploadFormData<T>(String path, FormData formData, {Map<String, String>? headers, Map<String, dynamic>? queryParameters, Duration? timeout, bool? useToken, int? maxRetries, List<int>? retryStatusCodes, T parser(dynamic)?}) → Future<HttpResponse<T>>

Upload form data (files + fields)

Operators

operator ==(Object other) → bool

The equality operator.

inherited