UrlRequest.Builder

const val REQUEST_PRIORITY_HIGHEST = 4: Int

Highest request priority. Passed to setPriority.

const val REQUEST_PRIORITY_IDLE = 0: Int

Lowest request priority. Passed to setPriority.

const val REQUEST_PRIORITY_LOW = 2: Int

Low request priority. Passed to setPriority.

const val REQUEST_PRIORITY_LOWEST = 1: Int

Very low request priority. Passed to setPriority.

const val REQUEST_PRIORITY_MEDIUM = 3: Int

Medium request priority. Passed to setPriority. This is the default priority given to the request.

abstract fun addHeader(header: String!, value: String!): UrlRequest.Builder!

Adds a request header.

fun addRequestAnnotation(annotation: Any!): UrlRequest.Builder!

Associates the annotation object with this request. May add more than one. Passed through to a RequestFinishedInfo.Listener, see getAnnotations.

abstract fun allowDirectExecutor(): UrlRequest.Builder!

Marks that the executors this request will use to notify callbacks (for UploadDataProviders and UrlRequest.Callbacks) is intentionally performing inline execution, like Guava's directExecutor or java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy.

Warning: This option makes it easy to accidentally block the network thread. It should not be used if your callbacks perform disk I/O, acquire locks, or call into other code you don't carefully control and audit.

fun bindToNetwork(networkHandle: Long): UrlRequest.Builder!

Binds the request to the specified network handle. Cronet will send this request only using the network associated to this handle. If this network disconnects the request will fail, the exact error will depend on the stage of request processing when the network disconnects. Network handles can be obtained through Network#getNetworkHandle. Only available starting from Android Marshmallow.

abstract fun build(): UrlRequest!

Creates a UrlRequest using configuration within this Builder. The returned UrlRequest can then be started by calling start.

abstract fun disableCache(): UrlRequest.Builder!

Disables cache for the request. If context is not set up to use cache, this call has no effect.

abstract fun setHttpMethod(method: String!): UrlRequest.Builder!

Sets the HTTP method verb to use for this request.

The default when this method is not called is "GET" if the request has no body or "POST" if it does.

abstract fun setPriority(priority: Int): UrlRequest.Builder!

Sets priority of the request which should be one of the REQUEST_PRIORITY_* values. The request is given REQUEST_PRIORITY_MEDIUM priority if this method is not called.

@UrlRequest.Experimental
fun setRawCompressionDictionary(
    dictionarySha256Hash: ByteArray!,
    dictionary: ByteBuffer!,
    dictionaryId: String!
): UrlRequest.Builder!

Allows Cronet to use the specified compression dictionary for this request. When specified, Cronet might signal to the server the availability of said compression dictionary. For this to have any effect, the CronetEngine that will execute this request must have been configured to enable a compression scheme that supports external dictionaries. This partially implements draft-ietf-httpbis-compression-dictionary within Cronet. Cronet won't directly handle "Use-As-Dictionary" response headers, it will instead rely on the embedder to: either, handle them and later call UrlRequest.Builder#setCompressionDictionary for requests which match Use-As-Dictionary's rules; or, fetch compression dictionaries via some other out of band mechanism, and later call UrlRequest.Builder#setCompressionDictionary. Cronet will interpret the dictionary as matching only this UrlRequest. If said request is redirected, and the embedder decides to follow the redirect, the dictionary will match also the new URL.

fun setRequestFinishedListener(listener: RequestFinishedInfo.Listener!): UrlRequest.Builder!

Sets a listener that gets invoked after onCanceled(), onFailed() or onSucceeded() return.

The listener is invoked with the request finished info on an java.util.concurrent.Executor provided by getExecutor().

fun setTrafficStatsTag(tag: Int): UrlRequest.Builder!

Sets android.net.TrafficStats tag to use when accounting socket traffic caused by this request. See android.net.TrafficStats for more information. If no tag is set (e.g. this method isn't called), then Android accounts for the socket traffic caused by this request as if the tag value were set to 0.

NOTE:Setting a tag disallows sharing of sockets with requests with other tags, which may adversely effect performance by prohibiting connection sharing. In other words use of multiplexed sockets (e.g. HTTP/2 and QUIC) will only be allowed if all requests have the same socket tag.

fun setTrafficStatsUid(uid: Int): UrlRequest.Builder!

Sets specific UID to use when accounting socket traffic caused by this request. See android.net.TrafficStats for more information. Designed for use when performing an operation on behalf of another application. Caller must hold MODIFY_NETWORK_ACCOUNTING permission. By default traffic is attributed to UID of caller.

NOTE:Setting a UID disallows sharing of sockets with requests with other UIDs, which may adversely effect performance by prohibiting connection sharing. In other words use of multiplexed sockets (e.g. HTTP/2 and QUIC) will only be allowed if all requests have the same UID set.

abstract fun setUploadDataProvider(
    uploadDataProvider: UploadDataProvider!,
    executor: Executor!
): UrlRequest.Builder!

Sets upload data provider. Switches method to "POST" if not explicitly set. Starting the request will throw an exception if a Content-Type header is not set.