RestOfflineQueueClient class - offline_queue library

Constructors

RestOfflineQueueClient(Client _inner, RequestSqliteCacheManager<Request> requestManager, {void onReattempt(Request request, int statusCode)?, void onRequestException(Request request, Object error)?, List<int>? reattemptForStatusCodes, Set<String>? ignorePaths})

Properties

hashCode → int: The hash code for this object.
no setterinherited
onReattempt ↔ void Function(Request request, int statusCode)?: A callback triggered when the response of a request has a status code which is present in the reattemptForStatusCodes list.
getter/setter pair
onRequestException ↔ void Function(Request request, Object error)?: A callback triggered when a request throws an exception during execution.
getter/setter pair
reattemptForStatusCodes → List<int>: If the response returned from the client is one of these error codes, the request will not be removed from the queue. For example, if the result of a request produces a 404 status code response (such as in a Tunnel not found exception), the request will be reattempted.
final
requestManager → RequestSqliteCacheManager<Request>: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

close() → void: Closes the client and cleans up any resources associated with it.
inherited
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>: Sends an HTTP DELETE request with the given headers to the given URL.
inherited
get(Uri url, {Map<String, String>? headers}) → Future<Response>: Sends an HTTP GET request with the given headers to the given URL.
inherited
head(Uri url, {Map<String, String>? headers}) → Future<Response>: Sends an HTTP HEAD request with the given headers to the given URL.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>: Sends an HTTP PATCH request with the given headers and body to the given URL.
inherited
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>: Sends an HTTP POST request with the given headers and body to the given URL.
inherited
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>: Sends an HTTP PUT request with the given headers and body to the given URL.
inherited
read(Uri url, {Map<String, String>? headers}) → Future<String>: Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>: Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<StreamedResponse>: Sends an HTTP request and asynchronously returns the response.
toString() → String: A string representation of this object.
inherited

Operators

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

Static Methods

isATunnelNotFoundResponse(Response response) → bool: Parse the returned response and determine if it needs to be removed from the queue. As a device with connectivity will still return a response if the endpoint is unreachable, false positives need to be filtered after the response is available.

Constants

policyHeader → const String: Describes the type of policy that came from the request, stringified from the OfflineFirstPolicy enum. The property will be removed before forwarding the request to _inner.