rtvi-client-android/ai.rtvi.client.result/Promise

Promise

class Promise<V, E>(val thread: ThreadRef) : Future<V, E>

Represents an ongoing asynchronous operation.

Promise implements the Future interface, which means it can be returned from functions performing asynchronous operations to provide callers a flexible way to wait for the response.

Constructors

Promise

constructor(thread: ThreadRef)

Properties

thread

open override val thread: ThreadRef

Functions

await

open suspend fun await(): V

Wait for the Future to complete using Kotlin Coroutines, and throw a VoiceException if the operation failed.

awaitNoThrow

open suspend fun awaitNoThrow(): Result<V, E>

Wait for the Future to complete using Kotlin Coroutines. Will return errors rather than throwing an exception.

chain

open fun <V2> chain(action: (V) -> Future<V2, E>): Future<V2, E>

When this Future completes, run another async operation.

logError

open fun logError(tag: String, description: String): Future<V, E>

If this operation fails, log an error.

map

open fun <V2> map(filter: (V) -> V2): Future<V2, E>

If the Future returns successfully, transform the result to another type.

mapError

open fun <E2> mapError(filter: (E) -> E2): Future<V, E2>

If the Future returns an error, transform the error to another type.

resolve

fun resolve(value: Result<V, E>)

Resolve the promise, notifying any pending callbacks.

resolveErr

fun resolveErr(error: E)

Convenience method to resolve a promise with an error.

resolveOk

fun resolveOk(value: V)

Convenience method to resolve a promise with a success value.

withCallback

open override fun withCallback(callback: ResultCallback<V, E>): Future<V, E>

Give a callback when the Future completes.

withErrorCallback

open fun withErrorCallback(callback: Callback<E>): Future<V, E>

Give a callback if the Future returns an error.

withTimeout

fun <V> Future<V, VoiceError>.withTimeout(durationMs: Long): Future<V, VoiceError>

Returns a new Future which times out after the specified duration.