java.lang.Object | ||
↳ | com.google.android.gms.common.api.PendingResult<R extends com.google.android.gms.common.api.Result> | |
↳ | com.google.android.gms.common.api.Batch |
Handles a batch of PendingResult
items. Callbacks can be added and you can block to wait
for all items in the batch to complete like any other PendingResult
item. A Batch can
also be canceled if the results are no longer needed. In this case, the onBatchComplete
callback will never be triggered.
The results can be taken either from the underlying PendingResult
s or via take(BatchResultToken)
but not both.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Batch.Builder | Builder for Batch objects. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mApiClient | This reference will never be null so long as the GoogleApiClient is connected. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Blocks until the task is completed.
| |||||||||||
Blocks until the task is completed or has timed out waiting for the result.
| |||||||||||
Requests that the batch be canceled.
| |||||||||||
Creates a result of type
<R> that represents a failure with the specified Status . | |||||||||||
Indicates whether the pending result has been canceled either due to calling
disconnect() or calling cancel() directly on the pending result or an
enclosing Batch . | |||||||||||
Set the callback here if you want the result to be delivered via a callback when the result is
ready.
| |||||||||||
Set the callback here if you want the result to be delivered via a callback when the result is
ready or has timed out waiting for the result.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
This reference will never be null so long as the GoogleApiClient is connected. It needs to be weak so that PendingResults don't pin disconnected GACs due to binder references to the PendingResults.
Blocks until the task is completed. This is not allowed on the UI thread. The returned result
object can have an additional failure mode of INTERRUPTED
.
Returns | |
---|---|
R extends Result |
Blocks until the task is completed or has timed out waiting for the result. This is not allowed
on the UI thread. The returned result object can have an additional failure mode of either
INTERRUPTED
or TIMEOUT
.
Parameters | |
---|---|
time |
long |
units |
TimeUnit |
Returns | |
---|---|
R extends Result |
Requests that the batch be canceled. Cancels all underlying PendingResult
s.
onResult(Result)
will never be called, await()
will return a
failed result with status CANCELED
.
Creates a result of type <R>
that represents a failure with the specified Status
.
Parameters | |
---|---|
status |
Status |
Returns | |
---|---|
BatchResult |
Indicates whether the pending result has been canceled either due to calling disconnect()
or calling cancel()
directly on the pending result or an
enclosing Batch
.
Returns | |
---|---|
boolean |
Set the callback here if you want the result to be delivered via a callback when the result is ready.
Parameters | |
---|---|
callback |
ResultCallback |
Set the callback here if you want the result to be delivered via a callback when the result is
ready or has timed out waiting for the result. The returned result object can have an
additional failure mode of TIMEOUT
.
Parameters | |
---|---|
callback |
ResultCallback |
time |
long |
units |
TimeUnit |