core/com.sentiance.sdk.pendingoperation/PendingOperation

PendingOperation

open class PendingOperation<Result, Error>

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.

Constructors

PendingOperation

constructor()

Properties

open val error: Error

open val result: Result

Functions

addOnCompleteListener

open fun addOnCompleteListener(@NonNull listener: OnCompleteListener<Result, Error>): PendingOperation<Result, Error>

Adds a listener that will be invoked after the operation completes.

addOnFailureListener

open fun addOnFailureListener(@NonNull listener: OnFailureListener<Error>): PendingOperation<Result, Error>

Adds a listener that will be invoked after the operation fails.

addOnSuccessListener

open fun addOnSuccessListener(@NonNull listener: OnSuccessListener<Result>): PendingOperation<Result, Error>

Adds a listener that will be invoked after the operation succeeds.

getResultOrNull

open fun getResultOrNull(): Result

Returns the result of the operation if it completed successfully.

open fun isComplete(): Boolean

Returns whether the operation has completed.

open fun isSuccessful(): Boolean

Returns whether the operation has succeeded.

open fun waitFor(timeout: Int, @NonNull unit: TimeUnit): PendingOperation<Result, Error>

Waits till the operation is complete for the duration that is specified.

waitTillCompletion

open fun waitTillCompletion(): PendingOperation<Result, Error>

Waits till the operation is complete.