thesportsdb-client/io.github.rohang27.thesportsdb/SportsDbFutures

SportsDbFutures

class SportsDbFutures(val client: SportsDbClient, scope: CoroutineScope) : AutoCloseable

A Java-friendly wrapper: every SportsDbClient method, returning a CompletableFuture.

SportsDbConfig config = new SportsDbConfig();
config.setApiKey(System.getenv("THESPORTSDB_API_KEY"));
try (SportsDbFutures db = new SportsDbFutures(config)) {
    Team team = db.v1().lookup().team(133604).join();
    db.v2().schedule().leagueNext(4328).thenAccept(events -> ...);
}

Single lookups complete with null when nothing is found. Failures complete the future exceptionally with a SportsDbException (wrapped in CompletionException by join()). close cancels calls still running.

Constructors

SportsDbFutures

constructor(client: SportsDbClient, scope: CoroutineScope)

constructor(client: SportsDbClient)

constructor(config: SportsDbConfig)

constructor()

Types

inner class HelpersFutures

CompletableFuture versions of Helpers.

inner class V1

CompletableFuture versions of V1Api.

inner class V1Lists

CompletableFuture versions of V1Api.Lists.

inner class V1Live

CompletableFuture versions of V1Api.Live.

inner class V1Lookup

CompletableFuture versions of V1Api.Lookup.

inner class V1Schedule

CompletableFuture versions of V1Api.Schedule.

inner class V1Search

CompletableFuture versions of V1Api.Search.

inner class V1Tv

CompletableFuture versions of V1Api.Tv.

inner class V1Video

CompletableFuture versions of V1Api.Video.

inner class V2

CompletableFuture versions of V2Api.

inner class V2All

CompletableFuture versions of V2Api.All.

inner class V2Lists

CompletableFuture versions of V2Api.Lists.

inner class V2Live

CompletableFuture versions of V2Api.Live.

inner class V2Lookup

CompletableFuture versions of V2Api.Lookup.

inner class V2Schedule

CompletableFuture versions of V2Api.Schedule.

inner class V2Search

CompletableFuture versions of V2Api.Search.

inner class V2Tv

CompletableFuture versions of V2Api.Tv.

Properties

val client: SportsDbClient

The underlying client, for Kotlin callers or for sharing its cache and rate limiter.

@get:JvmName(name = "helpers")

val helpers: SportsDbFutures.HelpersFutures

@get:JvmName(name = "v1")

val v1: SportsDbFutures.V1

@get:JvmName(name = "v2")

val v2: SportsDbFutures.V2

Functions

open override fun close()

fun isPremiumKey(): CompletableFuture<Boolean>

See SportsDbClient.isPremiumKey.