RequestFinishedInfo
Stay organized with collections
Save and categorize content based on your preferences.
Constant Summary
int |
CANCELED |
Reason value indicating that the request was canceled. |
int |
FAILED |
Reason value indicating that the request failed or returned an error. |
int |
SUCCEEDED |
Reason value indicating that the request succeeded. |
Public Constructor Summary
Inherited Method Summary
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
Constants
public
static
final
int
CANCELED
public
static
final
int
FAILED
Reason value indicating that the request failed or returned an error. Returned from getFinishedReason()
.
Constant Value:
1
public
static
final
int
SUCCEEDED
Public Constructors
public
RequestFinishedInfo
()
Public Methods
public
abstract
Collection<Object>
getAnnotations
()
Returns
- annotations supplied when creating the request
public
abstract
int
getFinishedReason
()
Returns the reason why the request finished.
public
abstract
String
getUrl
()
Returns the request's original URL.
Returns
- the request's original URL
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-10-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-26 UTC."],[],[],null,["# RequestFinishedInfo\n\npublic abstract class **RequestFinishedInfo** extends Object \nInformation about a finished request. Passed to [RequestFinishedInfo.Listener](../../../../reference/org/chromium/net/RequestFinishedInfo.Listener.html).\n\nTo associate the data with the original request, use [UrlRequest.Builder.addRequestAnnotation(Object)](../../../../reference/org/chromium/net/UrlRequest.Builder.html#addRequestAnnotation(java.lang.Object)) to add a unique identifier when creating the\nrequest, and call [getAnnotations()](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getAnnotations()) when the [RequestFinishedInfo](../../../../reference/org/chromium/net/RequestFinishedInfo.html) is received to\nretrieve the identifier. \n\n### Nested Class Summary\n\n|-------|---|---|----------------------------------------------------------------------|\n| class | [RequestFinishedInfo.Listener](../../../../reference/org/chromium/net/RequestFinishedInfo.Listener.html) || Listens for finished requests for the purpose of collecting metrics. |\n\n### Constant Summary\n\n|-----|----------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| int | [CANCELED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#CANCELED) | Reason value indicating that the request was canceled. |\n| int | [FAILED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#FAILED) | Reason value indicating that the request failed or returned an error. |\n| int | [SUCCEEDED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#SUCCEEDED) | Reason value indicating that the request succeeded. |\n\n### Public Constructor Summary\n\n|---|----------------------------------------------------------------------------------------------------------------|\n| | [RequestFinishedInfo](../../../../reference/org/chromium/net/RequestFinishedInfo.html#RequestFinishedInfo())() |\n\n### Public Method Summary\n\n|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract Collection\\\u003cObject\\\u003e | [getAnnotations](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getAnnotations())() Returns the objects that the caller has supplied when initiating the request, using [UrlRequest.Builder.addRequestAnnotation(Object)](../../../../reference/org/chromium/net/UrlRequest.Builder.html#addRequestAnnotation(java.lang.Object)). |\n| abstract [CronetException](../../../../reference/org/chromium/net/CronetException.html) | [getException](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getException())() If the request failed, returns the same [CronetException](../../../../reference/org/chromium/net/CronetException.html) provided to [UrlRequest.Callback.onFailed(UrlRequest, UrlResponseInfo, CronetException)](../../../../reference/org/chromium/net/UrlRequest.Callback.html#onFailed(org.chromium.net.UrlRequest,%20org.chromium.net.UrlResponseInfo,%20org.chromium.net.CronetException)). |\n| abstract int | [getFinishedReason](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getFinishedReason())() Returns the reason why the request finished. |\n| abstract [UrlResponseInfo](../../../../reference/org/chromium/net/UrlResponseInfo.html) | [getResponseInfo](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getResponseInfo())() Returns a [UrlResponseInfo](../../../../reference/org/chromium/net/UrlResponseInfo.html) for the request, if its response had started. |\n| abstract String | [getUrl](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getUrl())() Returns the request's original URL. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| Object | clone() |\n| boolean | equals(Object arg0) |\n| void | finalize() |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nConstants\n---------\n\n#### public static final int\n**CANCELED**\n\nReason value indicating that the request was canceled. Returned from [getFinishedReason()](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getFinishedReason()). \nConstant Value: 2 \n\n#### public static final int\n**FAILED**\n\nReason value indicating that the request failed or returned an error. Returned from [getFinishedReason()](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getFinishedReason()). \nConstant Value: 1 \n\n#### public static final int\n**SUCCEEDED**\n\nReason value indicating that the request succeeded. Returned from [getFinishedReason()](../../../../reference/org/chromium/net/RequestFinishedInfo.html#getFinishedReason()). \nConstant Value: 0\n\nPublic Constructors\n-------------------\n\n#### public\n**RequestFinishedInfo**\n()\n\n\u003cbr /\u003e\n\nPublic Methods\n--------------\n\n#### public abstract Collection\\\u003cObject\\\u003e\n**getAnnotations**\n()\n\nReturns the objects that the caller has supplied when initiating the request, using [UrlRequest.Builder.addRequestAnnotation(Object)](../../../../reference/org/chromium/net/UrlRequest.Builder.html#addRequestAnnotation(java.lang.Object)). Annotations can be used to associate a\n[RequestFinishedInfo](../../../../reference/org/chromium/net/RequestFinishedInfo.html) with the original request or type of request. \n\n##### Returns\n\n- annotations supplied when creating the request \n\n#### public abstract [CronetException](../../../../reference/org/chromium/net/CronetException.html)\n**getException**\n()\n\nIf the request failed, returns the same [CronetException](../../../../reference/org/chromium/net/CronetException.html) provided to [UrlRequest.Callback.onFailed(UrlRequest, UrlResponseInfo, CronetException)](../../../../reference/org/chromium/net/UrlRequest.Callback.html#onFailed(org.chromium.net.UrlRequest,%20org.chromium.net.UrlResponseInfo,%20org.chromium.net.CronetException)). \n\n##### Returns\n\n- the request's [CronetException](../../../../reference/org/chromium/net/CronetException.html), if the request failed \n\n#### public abstract int\n**getFinishedReason**\n()\n\nReturns the reason why the request finished. \n\n##### Returns\n\n- one of [SUCCEEDED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#SUCCEEDED), [FAILED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#FAILED), or [CANCELED](../../../../reference/org/chromium/net/RequestFinishedInfo.html#CANCELED) \n\n#### public abstract [UrlResponseInfo](../../../../reference/org/chromium/net/UrlResponseInfo.html)\n**getResponseInfo**\n()\n\nReturns a [UrlResponseInfo](../../../../reference/org/chromium/net/UrlResponseInfo.html) for the request, if its response had started. \n\n##### Returns\n\n- [UrlResponseInfo](../../../../reference/org/chromium/net/UrlResponseInfo.html) for the request, if its response had started. \n\n#### public abstract String\n**getUrl**\n()\n\nReturns the request's original URL. \n\n##### Returns\n\n- the request's original URL"]]