程序包 com.android.volley

类 Request<T>

java.lang.Object
com.android.volley.Request<T>
类型参数:
T - The type of parsed response this request expects.
所有已实现的接口:
Comparable<Request<T>>
直接已知子类:
ClearCacheRequest, GsonRequest, ImageRequest, JsonRequest, StringRequest
public abstract class Request<T> extends Object implements Comparable<Request<T>>
Base class for all network requests.

  • 构造器详细资料

    • Request

      @Deprecated public Request(String url, Response.ErrorListener listener)
      已过时。
      Use Request(int, String, com.android.volley.Response.ErrorListener).
      Creates a new request with the given URL and error listener. Note that the normal response listener is not provided here as delivery of responses is provided by subclasses, who have a better idea of how to deliver an already-parsed response.

    • Request

      public Request(int method, String url, Response.ErrorListener listener)
      Creates a new request with the given method (one of the values from Request.Method), URL, and error listener. Note that the normal response listener is not provided here as delivery of responses is provided by subclasses, who have a better idea of how to deliver an already-parsed response.

  • 方法详细资料

    • getMethod

      public int getMethod()
      Return the method for this request. Can be one of the values in Request.Method.

    • setTag

      public Request<?> setTag(Object tag)
      Set a tag on this request. Can be used to cancel all requests with this tag by RequestQueue.cancelAll(Object).
      返回:
      This Request object to allow for chaining.

    • getTag

      public Object getTag()
      Returns this request's tag.
      另请参阅:

    • getErrorListener

      public Response.ErrorListener getErrorListener()
      返回:
      this request's Response.ErrorListener.

    • getTrafficStatsTag

      public int getTrafficStatsTag()
      返回:
      A tag for use with TrafficStats.setThreadStatsTag(int)

    • setRetryPolicy

      public Request<?> setRetryPolicy(RetryPolicy retryPolicy)
      Sets the retry policy for this request.
      返回:
      This Request object to allow for chaining.

    • addMarker

      public void addMarker(String tag)
      Adds an event to this request's event log; for debugging.

    • setRequestQueue

      public Request<?> setRequestQueue(RequestQueue requestQueue)
      Associates this request with the given queue. The request queue will be notified when this request has finished.
      返回:
      This Request object to allow for chaining.

    • setSequence

      public final Request<?> setSequence(int sequence)
      Sets the sequence number of this request. Used by RequestQueue.
      返回:
      This Request object to allow for chaining.

    • getSequence

      public final int getSequence()
      Returns the sequence number of this request.

    • getUrl

      public String getUrl()
      Returns the URL of this request.

    • getCacheKey

      public String getCacheKey()
      Returns the cache key for this request. By default, this is the URL.

    • setCacheEntry

      public Request<?> setCacheEntry(Cache.Entry entry)
      Annotates this request with an entry retrieved for it from cache. Used for cache coherency support.
      返回:
      This Request object to allow for chaining.

    • getCacheEntry

      public Cache.Entry getCacheEntry()
      Returns the annotated cache entry, or null if there isn't one.

    • cancel

      public void cancel()
      Mark this request as canceled. No callback will be delivered.

    • isCanceled

      public boolean isCanceled()
      Returns true if this request has been canceled.

    • getHeaders

      public Map<String,String> getHeaders() throws AuthFailureError
      Returns a list of extra HTTP headers to go along with this request. Can throw AuthFailureError as authentication may be required to provide these values.
      抛出:
      AuthFailureError - In the event of auth failure

    • getPostParams

      @Deprecated protected Map<String,String> getPostParams() throws AuthFailureError
      已过时。
      Use getParams() instead.
      Returns a Map of POST parameters to be used for this request, or null if a simple GET should be used. Can throw AuthFailureError as authentication may be required to provide these values.

      Note that only one of getPostParams() and getPostBody() can return a non-null value.

      抛出:
      AuthFailureError - In the event of auth failure

    • getPostParamsEncoding

      @Deprecated protected String getPostParamsEncoding()
      已过时。
      Use getParamsEncoding() instead.
      Returns which encoding should be used when converting POST parameters returned by getPostParams() into a raw POST body.

      This controls both encodings:

      1. The string encoding used when converting parameter names and values into bytes prior to URL encoding them.
      2. The string encoding used when converting the URL encoded parameters into a raw byte array.

    • getPostBodyContentType

      @Deprecated public String getPostBodyContentType()
      已过时。
      Use getBodyContentType() instead.

    • getPostBody

      @Deprecated public byte[] getPostBody() throws AuthFailureError
      已过时。
      Use getBody() instead.
      Returns the raw POST body to be sent.
      抛出:
      AuthFailureError - In the event of auth failure

    • getParams

      protected Map<String,String> getParams() throws AuthFailureError
      Returns a Map of parameters to be used for a POST or PUT request. Can throw AuthFailureError as authentication may be required to provide these values.

      Note that you can directly override getBody() for custom data.

      抛出:
      AuthFailureError - in the event of auth failure

    • getParamsEncoding

      protected String getParamsEncoding()
      Returns which encoding should be used when converting POST or PUT parameters returned by getParams() into a raw POST or PUT body.

      This controls both encodings:

      1. The string encoding used when converting parameter names and values into bytes prior to URL encoding them.
      2. The string encoding used when converting the URL encoded parameters into a raw byte array.

    • getBodyContentType

      public String getBodyContentType()
      Returns the content type of the POST or PUT body.

    • getBody

      public byte[] getBody() throws AuthFailureError
      Returns the raw POST or PUT body to be sent.

      By default, the body consists of the request parameters in application/x-www-form-urlencoded format. When overriding this method, consider overriding getBodyContentType() as well to match the new body format.

      抛出:
      AuthFailureError - in the event of auth failure

    • setShouldCache

      public final Request<?> setShouldCache(boolean shouldCache)
      Set whether or not responses to this request should be cached.
      返回:
      This Request object to allow for chaining.

    • shouldCache

      public final boolean shouldCache()
      Returns true if responses to this request should be cached.

    • getPriority

      public Request.Priority getPriority()
      Returns the Request.Priority of this request; Request.Priority.NORMAL by default.

    • getTimeoutMs

      public final int getTimeoutMs()
      Returns the socket timeout in milliseconds per retry attempt. (This value can be changed per retry attempt if a backoff is specified via backoffTimeout()). If there are no retry attempts remaining, this will cause delivery of a TimeoutError error.

    • getRetryPolicy

      public RetryPolicy getRetryPolicy()
      Returns the retry policy that should be used for this request.

    • markDelivered

      public void markDelivered()
      Mark this request as having a response delivered on it. This can be used later in the request's lifetime for suppressing identical responses.

    • hasHadResponseDelivered

      public boolean hasHadResponseDelivered()
      Returns true if this request has had a response delivered for it.

    • parseNetworkResponse

      protected abstract Response<T> parseNetworkResponse(NetworkResponse response)
      Subclasses must implement this to parse the raw network response and return an appropriate response type. This method will be called from a worker thread. The response will not be delivered if you return null.
      参数:
      response - Response from the network
      返回:
      The parsed response, or null in the case of an error

    • parseNetworkError

      protected VolleyError parseNetworkError(VolleyError volleyError)
      Subclasses can override this method to parse 'networkError' and return a more specific error.

      The default implementation just returns the passed 'networkError'.

      参数:
      volleyError - the error retrieved from the network
      返回:
      an NetworkError augmented with additional information

    • deliverResponse

      protected abstract void deliverResponse(T response)
      Subclasses must implement this to perform delivery of the parsed response to their listeners. The given response is guaranteed to be non-null; responses that fail to parse are not delivered.
      参数:
      response - The parsed response returned by parseNetworkResponse(NetworkResponse)

    • deliverError

      public void deliverError(VolleyError error)
      Delivers error message to the ErrorListener that the Request was initialized with.
      参数:
      error - Error details

    • compareTo

      public int compareTo(Request<T> other)
      Our comparator sorts from high to low priority, and secondarily by sequence number to provide FIFO ordering.
      指定者:
      compareTo 在接口中 Comparable<T>

    • toString

      public String toString()
      覆盖:
      toString 在类中 Object