Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 2.99 KB

README.md

File metadata and controls

95 lines (72 loc) · 2.99 KB

PendingOperation

A reference to an ongoing asynchronous SDK operation, whose result is not yet known. It provides methods for checking whether the operation is complete, and whether it has succeeded. Additionally, it offers the ability to get its result either synchronously (blocking), or asynchronously via listeners.

If the operation succeeds, all completion and success listeners will be notified. The result will also be made available via the getResult() method. If the operation fails, all completion and failure listeners will be notified, and the error will be made available via the getError() method.

PendingOperation API

addOnCompleteListener

PendingOperation<Result,Error> addOnCompleteListener(OnCompleteListener<Result, Error> listener)

Adds an OnCompleteListener that will be invoked after the operation completes.

addOnSuccessListener

PendingOperation<Result,Error> addOnSuccessListener(OnSuccessListener<Result> listener)

Adds an OnSuccessListener that will be invoked after the operation succeeds.

addOnFailureListener

PendingOperation<Result,Error> addOnFailureListener(OnFailureListener<Error> listener)

Adds an OnFailureListener that will be invoked after the operation fails.

isComplete

boolean isComplete()

Returns whether the operation has completed. If true, you can call isSuccessful() to check whether it succeeded.

isSuccessful

boolean isSuccessful()

Returns whether the operation has succeeded. If this method returns true, you can call getResult() to obtain the result. Otherwise if it returns false, you can call getError() to obtain the error.

waitFor

PendingOperation<Result, Error> waitFor(int timeout, TimeUnit unit)

Waits till the operation is complete for the duration that is specified. Call {@link #isComplete()} after this method, to check whether the operation completed or if this method timed out.

@throws InterruptedException if thread is interrupted while waiting

waitTillCompletion

PendingOperation<Result, Error> waitTillCompletion()

Waits till the operation is complete.

throws InterruptedException if thread is interrupted while waiting.

getResult

Result getResult()

Returns the result of the operation.

throws InterruptedException if thread is interrupted while waiting. throws SdkException if the operation has failed.

getResultOrNull

Result getResultOrNull()

Returns the result of the operation if it completed successfully. Otherwise returns null.

getError

Error getError()

Returns the error encountered during the operation.

throws IllegalStateException if the operation is not yet complete. throws SdkException if the PendingOperation has succeeded.