RestClient class

Constructors

RestClient(HttpClient _httpClient, {HttpAuth? auth})

Properties

auth ↔ HttpAuth?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isHttp2 → bool

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → Future<void>

delete(String endpoint, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}}) → Future<RestResponse<void>>

getList<TResponse>(String endpoint, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<List<TResponse>>>

getObject<TResponse>(String endpoint, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<TResponse>>

handleResponse<TData, TResponse>(HttpResponse response, TransferBean<TData>? bean) → Future<RestResponse<TResponse>>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchObject<TResponse>(String endpoint, dynamic object, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<TResponse>>

postObject<TResponse>(String endpoint, dynamic object, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<TResponse>>

putObject<TResponse>(String endpoint, dynamic object, {Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<TResponse>>

rawRequest<TResponse>(ApiRequestMethod method, String endpoint, {dynamic body, Map<String, dynamic> urlParams = const {}, Map<String, String?> query = const {}, Map<String, List<String>> headers = const {}, TransferBean<TResponse>? bean}) → Future<RestResponse<TResponse>>

request<TData, TResponse>(ApiRequestMethod method, RoutePattern endpoint, Map<String, dynamic> urlParams, {Map<String, List<String>> headers = const {}, Map<String, String?> query = const {}, dynamic body, TransferBean<TData>? bean}) → Future<RestResponse<TResponse>>

toString() → String

A string representation of this object.

inherited

withAuth(HttpAuth? auth) → RestClient

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

connect(Uri address, {HttpAuth? auth, SecurityContext? securityContext, bool onBadCertificate(X509Certificate certificate)?, Duration? timeout}) → Future<RestClient>

Create a RestClient that automatically negotiates HTTP versions.

connectHttp11(Uri address, {HttpAuth? auth, SecurityContext? securityContext, bool onBadCertificate(X509Certificate certificate)?, Duration? timeout}) → Future<RestClient>

Create a RestClient with an underlying HTTP 1.1 client.

connectHttp2(Uri address, {HttpAuth? auth, SecurityContext? securityContext, bool onBadCertificate(X509Certificate certificate)?, Duration? timeout}) → Future<RestClient>

Create a RestClient with an underlying HTTP 2 client.