BrowserHttpClient class abstract

Implemented by HttpClient when the application runs in browser.

Implemented types

Properties

authenticate ← (Future<bool> Function(Uri url, String scheme, String? realm)?)
Sets the function to be called when a site is requesting authentication.
no getterinherited
authenticateProxy ← (Future<bool> Function(String host, int port, String scheme, String? realm)?)
Sets the function to be called when a proxy is requesting authentication.
no getterinherited
autoUncompress ↔ bool
Gets and sets whether the body of a response will be automatically uncompressed.
getter/setter pairinherited
badCertificateCallback ← (bool Function(X509Certificate cert, String host, int port)?)
Sets a callback that will decide whether to accept a secure connection with a server certificate that cannot be authenticated by any of our trusted root certificates.
no getterinherited
browserCredentialsMode ↔ bool
Enables CORS "credentials mode" for all XHR requests. Disabled by default.
getter/setter pair
connectionFactory ← (Future<ConnectionTask<Socket>> Function(Uri url, String? proxyHost, int? proxyPort)?)
Sets the function used to create socket connections.
no getterinherited
connectionTimeout ↔ Duration?
Gets and sets the connection timeout.
getter/setter pairinherited
findProxy ← (String Function(Uri url)?)
Sets the function used to resolve the proxy server to be used for opening a HTTP connection to the specified url. If this function is not set, direct connections will always be used.
no getterinherited
hashCode → int
The hash code for this object.
no setterinherited
idleTimeout ↔ Duration
Gets and sets the idle timeout of non-active persistent (keep-alive) connections.
getter/setter pairinherited
keyLog ← (dynamic Function(String line)?)
Sets a callback that will be called when new TLS keys are exchanged with the server. It will receive one line of text in NSS Key Log Format for each call. Writing these lines to a file will allow tools (such as Wireshark) to decrypt communication between the this client and the server. This is meant to allow network-level debugging of secure sockets and should not be used in production code. For example:
no getterinherited
maxConnectionsPerHost ↔ int?
Gets and sets the maximum number of live connections, to a single host.
getter/setter pairinherited
onBrowserHttpClientRequestClose ↔ (FutureOr<void> Function(BrowserHttpClientRequest request)?)
Enables you to set BrowserHttpClientRequest.browserRequestType before any XHR request is sent to the server.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
userAgent ↔ String?
Gets and sets the default value of the User-Agent header for all requests generated by this HttpClient.
getter/setter pairinherited

Methods

addCredentials(Uri url, String realm, HttpClientCredentials credentials) → void
Add credentials to be used for authorizing HTTP requests.
inherited
addProxyCredentials(String host, int port, String realm, HttpClientCredentials credentials) → void
Add credentials to be used for authorizing HTTP proxies.
inherited
close({bool force = false}) → void
Shuts down the HTTP client.
inherited
delete(String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection using the DELETE method.
inherited
deleteUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the DELETE method.
inherited
get(String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection using the GET method.
inherited
getUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the GET method.
inherited
Opens a HTTP connection using the HEAD method.
inherited
headUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the HEAD method.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
open(String method, String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection.
inherited
openUrl(String method, Uri url) → Future<HttpClientRequest>
Opens a HTTP connection.
inherited
patch(String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection using the PATCH method.
inherited
patchUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the PATCH method.
inherited
post(String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection using the POST method.
inherited
postUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the POST method.
inherited
put(String host, int port, String path) → Future<HttpClientRequest>
Opens a HTTP connection using the PUT method.
inherited
putUrl(Uri url) → Future<HttpClientRequest>
Opens a HTTP connection using the PUT method.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Constants

defaultTextMimes → const Set<String>
HTTP request header "Accept" MIMEs that will cause XMLHttpRequest to use request type "text", which also makes it possible to read the HTTP response body progressively in chunks.