JsonServiceClient class

Implemented types

• IServiceClient

Available extensions

• ServiceClientExtensions

Constructors

JsonServiceClient([String? baseUrl = "/"])

JsonServiceClient.api([String? baseUrl = "/"])

JsonServiceClient.legacy([String? baseUrl = "/"])

Properties

basePath ← String?

no getter

baseUrl ↔ String?

getter/setter pair, override

bearerToken ↔ String?

getter/setter pair, override

client ↔ HttpClient

getter/setter pair

connectionTimeout ↔ Duration?

getter/setter pair

cookies ↔ List<Cookie>?

getter/setter pair

exceptionFilter ↔ ResponseExceptionFilter?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

headers ↔ Map<String, String>

getter/setter pair

maxRetries ↔ int

getter/setter pair

onAuthenticationRequired ↔ AsyncCallbackFunction?

getter/setter pair, override

oneWayBaseUrl ↔ String?

getter/setter pair, override

password ↔ String?

getter/setter pair, override

refreshToken ↔ String?

getter/setter pair, override

refreshTokenUri ↔ String?

getter/setter pair

replyBaseUrl ↔ String?

getter/setter pair, override

requestFilter ↔ RequestFilter?

getter/setter pair

responseFilter ↔ ResponseFilter?

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

urlFilter ↔ UrlFilter?

getter/setter pair

userName ↔ String?

getter/setter pair, override

useTokenCookie ↔ bool

getter/setter pair

Methods

api<T>(IReturn<T> request, {Map<String, dynamic>? args, String? method}) → Future<ApiResult<T>>

override

apiVoid(IReturnVoid request, {Map<String, dynamic>? args, String? method}) → Future<ApiResult<EmptyResponse>>

override

clearCookies() → void

override

close({bool force = false}) → void

override

createRequest(SendContext info) → Future<HttpClientRequest>

createResponse<T>(HttpClientResponse res, SendContext info) → Future<T?>

createUrlFromDto<T>(String method, dynamic request) → String?

Available on IServiceClient, provided by the ServiceClientExtensions extension

delete<T>(IReturn<T> request, {Map<String, dynamic>? args}) → Future<T>

override

deleteAs<T>(String path, {Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

deleteUrl(String path, {Map<String, dynamic>? args}) → Future<Map<String, dynamic>>

override

fetch<T>(String method, dynamic request, [Map<String, dynamic>? args, String? url]) → Future<T>

get<T>(IReturn<T> request, {Map<String, dynamic>? args}) → Future<T>

override

getAs<T>(String path, {Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

getRefreshTokenCookie() → String?

override

getTokenCookie() → String?

override

getUrl(String path, {Map<String, dynamic>? args}) → Future<Map<String, dynamic>>

override

handleError<T>(HttpClientResponse? holdRes, Exception e, [WebServiceExceptionType? type]) → Future<T>

mergeCookies(List<Cookie> cookies) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch<T>(IReturn<T> request, {dynamic body, Map<String, dynamic>? args}) → Future<T>

override

patchAs<T>(String path, dynamic body, {Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

patchToUrl(String path, dynamic body, {Map<String, dynamic>? args}) → Future<Map<String, dynamic>>

override

post<T>(IReturn<T> request, {dynamic body, Map<String, dynamic>? args}) → Future<T>

override

postAs<T>(String path, dynamic body, {Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

postFilesWithRequest<T>(IReturn<T> request, List<UploadFile> files, {RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

Posts files with a request DTO using multipart/form-data

postFilesWithRequestAs<T>(String requestUri, dynamic request, List<UploadFile> files, {T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

Posts files with a request DTO using multipart/form-data

postFileWithRequest<T>(IReturn<T> request, UploadFile file, {RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

Posts files with a request DTO using multipart/form-data

postToUrl(String path, dynamic body, {Map<String, dynamic>? args}) → Future<Map<String, dynamic>>

override

put<T>(IReturn<T> request, {dynamic body, Map<String, dynamic>? args}) → Future<T>

override

putAs<T>(String path, dynamic body, {Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

putToUrl(String path, dynamic body, {Map<String, dynamic>? args}) → Future<Map<String, dynamic>>

override

raiseError(HttpClientResponse? res, Exception error) → Exception

send<T>(IReturn<T> request, {String? method, dynamic body, Map<String, dynamic>? args, T? responseAs, RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<T>

override

sendAll<T>(Iterable<IReturn<T>> requests, {RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<List<T>>

override

sendAllOneWay<T>(Iterable<IReturn<T>> requests, {RequestFilter? requestFilter, ResponseFilter? responseFilter}) → Future<void>

override

sendRequest<T>(SendContext info) → Future<T>

setCredentials(String? userName, String? password) → void

Available on IServiceClient, provided by the ServiceClientExtensions extension

toAbsoluteUrl(String relativeOrAbsoluteUrl) → String

Available on IServiceClient, provided by the ServiceClientExtensions extension

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

globalExceptionFilter ↔ ResponseExceptionFilter?

getter/setter pair

globalRequestFilter ↔ RequestFilter?

getter/setter pair

globalResponseFilter ↔ ResponseFilter?

getter/setter pair