spotify-api-kotlin/com.adamratzman.spotify/SpotifyRestAction

SpotifyRestAction

open class SpotifyRestAction<T>(source)

Provides a uniform interface to retrieve, whether synchronously or asynchronously, T from Spotify

Properties

val supplier: suspend () -> T

Functions

fun <T> SpotifyRestAction<T>.asPromise(): Promise<T>

fun complete(): T

Invoke supplier and synchronously retrieve T. This is only available on JVM/Native and will fail on JS.

fun hasCompleted(): Boolean

Whether this REST action has been fully completed

fun hasRun(): Boolean

Whether this REST action has been commenced.

fun queue(failure: (Throwable) -> Unit = { throw it }, consumer: (T) -> Unit = {})

Invoke supplier asynchronously and consume consumer with the T value returned

fun queueAfter(quantity: Int, timeUnit: TimeUnit = TimeUnit.Seconds, scope: CoroutineScope = GlobalScope, failure: (Throwable) -> Unit = { throw it }, consumer: (T) -> Unit)

Invoke supplier asynchronously immediately and invoke consumer after the specified quantity of time.

suspendComplete

suspend fun suspendComplete(context: CoroutineContext = Dispatchers.Default): T

Switch to given context, invoke SpotifyRestAction.supplier and synchronously retrieve T

suspend fun suspendQueue(): T

Suspend the coroutine, invoke SpotifyRestAction.supplier asynchronously/queued and resume with result T

open override fun toString(): String