Rest class abstract

An abastract class to use to connect to rest services.

Constructors

Rest({int connectTimeout = 30000, int receiveTimeout = 30000, String defaultContentType = "application/json"})

Properties

connectTimeout ↔ int
The time in milliseconds to wait to open a connection
getter/setter pair
defaultContentType ↔ String
Default content type to use in post requests
getter/setter pair
dio ↔ Dio
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
receiveTimeout ↔ int
The time in milliseconds to wait to receive a response
getter/setter pair
restUrl → String
Base url for the rest service
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addInterceptor(Interceptor interceptor) → void
addPermanentQuery(String name, String value) → void
Add a query parameter permanently to all requests
composeUrl(String path, {Map<String, dynamic>? query, bool checkSlashs = false, bool allowNullQueries = false, String? baseUrl}) → String
Creates the request url based on the restUrl, a given path and some optional query paramaters.
delete(String path, {String? baseUrl, String? contenttype, Map<String, dynamic>? query, Options? options}) → Future
get(String path, {String? baseUrl, Map<String, dynamic>? query, Options? options}) → Future
Get Request
hasInterceptor(Interceptor interceptor) → bool
listByGet<T>(String path, T parse(Map<String, dynamic> mp), {String? baseUrl, Map<String, dynamic>? query, Options? options}) → Future<List<T>>
Get request and parses the result using given parser
listByPost<T>(String path, dynamic body, T parse(Map<String, dynamic> item), {String? baseUrl, Map<String, dynamic>? query, String? contentType, Options? options}) → Future<List<T>>
Post request and parses the result using given parser
modelByGet<T>(String path, T parse(Map<String, dynamic>? item), {String? baseUrl, Map<String, dynamic>? query, Options? options}) → Future<T>
Get request and parses the result using given parser
modelByPost<T>(String path, dynamic body, T parse(Map<String, dynamic>? item), {String? baseUrl, Map<String, dynamic>? query, String? contentType, Options? options}) → Future<T>
Post request and parses the result using given parser
modelByPut<T>(String path, dynamic body, T parse(Map<String, dynamic>? item), {String? baseUrl, Map<String, dynamic>? query, Options? options}) → Future<T>
Put request and parses the result using given parser
modelByUpload<T>(String path, File file, T parse(dynamic dynamic), {String? fileName, String? baseUrl, Map<String, dynamic>? query, Options? options, String? fileKey, MediaType? fileMime, Map<String, dynamic>? extraInfo}) → Future<T>
Upload a file and parses the result using given parser
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(String path, dynamic data, {String? baseUrl, String? contenttype, Map<String, dynamic>? query, Options? options}) → Future
post(String path, dynamic data, {String? baseUrl, String? contenttype, Map<String, dynamic>? query, Options? options}) → Future
Post Request
put(String path, dynamic data, {String? baseUrl, String? contenttype, Map<String, dynamic>? query, Options? options}) → Future
Put Request
removeInterceptor(Interceptor interceptor) → void
removePermanentQuery(String name) → void
Remove a permanentrly query parameter
toString() → String
A string representation of this object.
inherited
upload(String path, File file, {String? fileName, String? fileType, String? baseUrl, Map<String, dynamic>? query, Options? options, String? fileKey, MediaType? fileMime, Map<String, dynamic>? extraInfo}) → Future

Operators

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