BrowserClient class
A package:web-based HTTP client that runs in the browser and is backed by window.fetch.
This client inherits some limitations of window.fetch:
- BaseRequest.persistentConnection is ignored;
- Setting BaseRequest.followRedirects to
falsewill cause ClientException when a redirect is encountered; - The value of BaseRequest.maxRedirects is ignored.
Responses are streamed but requests are not. A request will only be sent once all the data is available.
- Inheritance
-
- Object
- BaseClient
- BrowserClient
Constructors
Properties
- hashCode → int
- The hash code for this object. no setterinherited
- runtimeType → Type
- A representation of the runtime type of the object. no setterinherited
- withCredentials ↔ bool
- Whether to send credentials such as cookies or authorization headers for cross-site requests. getter/setter pair
Methods
- close(
) → void - Closes the client. override
- 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. override
- toString(
) → String - A string representation of this object. inherited
Operators
- operator ==(
Object other) → bool - The equality operator. inherited