Stay organized with collections
Save and categorize content based on your preferences.
abstract class OptionalPendingResult<R : Result?> : PendingResult
Each OptionalPendingResult is a PendingResult with additional support for non-blocking accessors. The result of an OptionalPendingResult may be available immediately. If the result is available isDone will return true.
| Parameters |
<R : Result?> |
Result returned by various accessors.
|
Summary
Public functions |
abstract R! |
Returns the Result immediately if it is available.
|
abstract Boolean |
Returns true if the result is available immediately, false otherwise.
|
Inherited functions |
From com.google.android.gms.common.api.PendingResult
abstract R |
Blocks until the task is completed.
|
abstract R |
Blocks until the task is completed or has timed out waiting for the result.
|
abstract Unit |
Requests that the PendingResult be canceled.
|
abstract Boolean |
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.
|
abstract Unit |
Set the callback here if you want the result to be delivered via a callback when the result is ready.
|
abstract Unit |
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.
|
TransformedResult<S!> |
Transforms the result by making another API call.
|
|
Public functions
abstract fun get(): R!
Returns the Result immediately if it is available. If the result is not available, an exception will be thrown. This method should only be called after checking that isDone returns true.
After the result has been retrieved using get, await, or has been delivered to the result callback, it is an error to attempt to retrieve the result again. It is the responsibility of the caller or callback receiver to release any resources associated with the returned result. Some result types may implement Releasable, in which case release should be used to free the associated resources.
abstract fun isDone(): Boolean
Returns true if the result is available immediately, false otherwise.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 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 2024-10-31 UTC."],[[["`OptionalPendingResult` extends `PendingResult` and provides non-blocking access to results."],["The result may be immediately available, check with `isDone()` before accessing it with `get()`."],["If `isDone()` returns true, `get()` returns the `Result` immediately; otherwise, it throws an exception."],["Avoid retrieving the result multiple times after it's been obtained via `get()`, `await()`, or the result callback."],["Some result types may implement `Releasable`; if so, use `release()` to free resources."]]],[]]
