UrlResponseInfo

abstract class UrlResponseInfo


Basic information about a response. Included in UrlRequest.Callback callbacks. Each onRedirectReceived() callback gets a different copy of UrlResponseInfo describing a particular redirect response.

Summary

Nested types

Unmodifiable container of response headers or trailers.

Public constructors

Public functions

abstract (Mutable)Map<String!, (Mutable)List<String!>!>!

Returns an unmodifiable map of the response-header fields and values.

abstract (Mutable)List<(Mutable)Map.Entry<String!, String!>!>!

Returns an unmodifiable list of response header field and value pairs.

abstract Int

Returns the HTTP status code.

abstract String!

Returns the HTTP status text of the status line.

abstract String!

Returns the protocol (for example 'quic/1+spdy/3') negotiated with the server.

abstract String!

Returns the proxy server that was used for the request.

abstract Long

Returns a minimum count of bytes received from the network to process this request.

abstract String!

Returns the URL the response is for.

abstract (Mutable)List<String!>!

Returns the URL chain.

abstract Boolean

Returns true if the response came from the cache, including requests that were revalidated over the network before being retrieved from the cache.

Public constructors

UrlResponseInfo

UrlResponseInfo()

Public functions

getAllHeaders

abstract fun getAllHeaders(): (Mutable)Map<String!, (Mutable)List<String!>!>!

Returns an unmodifiable map of the response-header fields and values. Each list of values for a single header field is in the same order they were received over the wire.

Returns
(Mutable)Map<String!, (Mutable)List<String!>!>!

an unmodifiable map of the response-header fields and values.

getAllHeadersAsList

abstract fun getAllHeadersAsList(): (Mutable)List<(Mutable)Map.Entry<String!, String!>!>!

Returns an unmodifiable list of response header field and value pairs. The headers are in the same order they are received over the wire.

Returns
(Mutable)List<(Mutable)Map.Entry<String!, String!>!>!

an unmodifiable list of response header field and value pairs.

getHttpStatusCode

abstract fun getHttpStatusCode(): Int

Returns the HTTP status code. When a resource is retrieved from the cache, whether it was revalidated or not, the original status code is returned.

Returns
Int

the HTTP status code.

getHttpStatusText

abstract fun getHttpStatusText(): String!

Returns the HTTP status text of the status line. For example, if the request received a "HTTP/1.1 200 OK" response, this method returns "OK".

Returns
String!

the HTTP status text of the status line.

getNegotiatedProtocol

abstract fun getNegotiatedProtocol(): String!

Returns the protocol (for example 'quic/1+spdy/3') negotiated with the server. Returns an empty string if no protocol was negotiated, the protocol is not known, or when using plain HTTP or HTTPS.

Returns
String!

the protocol negotiated with the server.

getProxyServer

abstract fun getProxyServer(): String!

Returns the proxy server that was used for the request.

Returns
String!

the proxy server that was used for the request.

getReceivedByteCount

abstract fun getReceivedByteCount(): Long

Returns a minimum count of bytes received from the network to process this request. This count may ignore certain overheads (for example IP and TCP/UDP framing, SSL handshake and framing, proxy handling). This count is taken prior to decompression (for example GZIP) and includes headers and data from all redirects. This value may change (even for one UrlResponseInfo instance) as the request progresses until completion, when onSucceeded(), onFailed(), or onCanceled() is called.

Returns
Long

a minimum count of bytes received from the network to process this request.

getUrl

abstract fun getUrl(): String!

Returns the URL the response is for. This is the URL after following redirects, so it may not be the originally requested URL.

Returns
String!

the URL the response is for.

getUrlChain

abstract fun getUrlChain(): (Mutable)List<String!>!

Returns the URL chain. The first entry is the originally requested URL; the following entries are redirects followed.

Returns
(Mutable)List<String!>!

the URL chain.

wasCached

abstract fun wasCached(): Boolean

Returns true if the response came from the cache, including requests that were revalidated over the network before being retrieved from the cache.

Returns
Boolean

true if the response came from the cache, false otherwise.