Summary: Nested Classes | Methods | Inherited Methods

UrlRequest

Kotlin |Java

public abstract class UrlRequest
extends Object

java.lang.Object
↳	android.net.http.UrlRequest

Controls an HTTP request (GET, PUT, POST etc). Created by UrlRequest.Builder, which can be obtained by calling HttpEngine#newUrlRequestBuilder. Note: All methods must be called on the Executor passed to HttpEngine#newUrlRequestBuilder.

Summary

Nested classes
`class`	`UrlRequest.Builder` Builder for `UrlRequest`s.
`class`	`UrlRequest.Callback` Users of the HTTP stack extend this class to receive callbacks indicating the progress of a `UrlRequest` being processed.
`class`	`UrlRequest.Status` Request status values returned by `UrlRequest.getStatus(UrlRequest.StatusListener)`.
`class`	`UrlRequest.StatusListener` Listener class used with `UrlRequest.getStatus(UrlRequest.StatusListener)` to receive the status of a `UrlRequest`.

Public methods
`abstract void`	`cancel()` Cancels the request.
`abstract void`	`followRedirect()` Follows a pending redirect.
`abstract void`	`getStatus(UrlRequest.StatusListener listener)` Queries the status of the request.
`abstract boolean`	`isDone()` Returns `true` if the request was successfully started and is now finished (completed, canceled, or failed).
`abstract void`	`read(ByteBuffer buffer)` Attempts to read part of the response body into the provided buffer.
`abstract void`	`start()` Starts the request, all callbacks go to `Callback`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

cancel

Added in Android UpsideDownCake

public abstract void cancel ()

Cancels the request. Can be called at any time. onCanceled() will be invoked when cancellation is complete and no further callback methods will be invoked. If the request has completed or has not started, calling cancel() has no effect and onCanceled() will not be invoked. If the Executor passed in during UrlRequest construction runs tasks on a single thread, and cancel() is called on that thread, no callback methods (besides onCanceled()) will be invoked after cancel() is called. Otherwise, at most one callback method may be invoked after cancel() has completed.

followRedirect

Added in Android UpsideDownCake

public abstract void followRedirect ()

Follows a pending redirect. Must only be called at most once for each invocation of onRedirectReceived().

getStatus

Added in Android UpsideDownCake

public abstract void getStatus (UrlRequest.StatusListener listener)

Queries the status of the request.

This is most useful to query the status of the request before any of the UrlRequest.Callback methods are called by Cronet.

The listener will be invoked back on the Executor passed in when the request was created. While you can assume the callback will be invoked in a timely fashion, the API doesn't make any guarantees about the latency, nor does it specify the order in which the listener and other callbacks will be invoked.

Parameters
`listener`	`UrlRequest.StatusListener`: a `StatusListener` that will be invoked with the request's current status.

isDone

Added in Android UpsideDownCake

public abstract boolean isDone ()

Returns true if the request was successfully started and is now finished (completed, canceled, or failed).

Returns
`boolean`	`true` if the request was successfully started and is now finished (completed, canceled, or failed).

read

Added in Android UpsideDownCake

public abstract void read (ByteBuffer buffer)

Attempts to read part of the response body into the provided buffer. Must only be called at most once in response to each invocation of the onResponseStarted() and onReadCompleted() methods of the Callback. Each call will result in an asynchronous call to either the Callback's onReadCompleted() method if data is read, its onSucceeded() method if there's no more data to read, or its onFailed() method if there's an error.

Parameters
`buffer`	`ByteBuffer`: `ByteBuffer` to write response body to. Must be a direct ByteBuffer. The embedder must not read or modify buffer's position, limit, or data between its position and limit until the request calls back into the `Callback`.

start

Added in Android UpsideDownCake

public abstract void start ()

Starts the request, all callbacks go to Callback. May only be called once. May not be called if cancel() has been called.

UrlRequest

Summary

Nested classes

Public methods

Inherited methods

Public methods

cancel

followRedirect

getStatus

isDone

read

start