TDL Coroutines

TDL Coroutines is a Kotlin Multiplatform library that provides a coroutine-based client for the Telegram Database Library (TDLib). It simplifies sending requests and handling updates, making TDLib integration more straightforward and idiomatic for Kotlin Multiplatform projects.

Mobile
Desktop

Gradle setup

repositories {
    mavenCentral()
}

Replace X.X.X with the version from the Maven Central badge.

dependencies {
    implementation("dev.g000sha256:tdl-coroutines:X.X.X")
}

Usage

Caution

Upstream TDLib may include breaking API changes even in patch releases. Since TDL Coroutines wraps TDLib, these changes propagate to this library as well. To minimize the impact, use named arguments when calling generated constructors and request methods, because parameters may be added, renamed, or removed in future releases.

Create a client

val client = TdlClient.create()

Important

Start collecting the update flows you need before sending the first request.

Subscribe to updates

TdlClient provides 184 update flows and the allUpdates flow, which combines all update events.

coroutineScope.launch {
    client.authorizationStateUpdates.collect { update ->
        val authorizationState = update.authorizationState
        // TODO
    }
}

coroutineScope.launch {
    client.allUpdates.collect { update ->
        when (update) {
            is UpdateAuthorizationState -> {
                val authorizationState = update.authorizationState
                // TODO
            }
            is UpdateOption -> {
                val name = update.name
                val value = update.value
                // TODO
            }
            // TODO
        }
    }
}

Send a request

TdlClient provides 1010 request methods.

coroutineScope.launch {
    val result = client.getAuthorizationState()
    when (result) {
        is TdlResult.Failure -> {
            val code = result.code
            val message = result.message
            // TODO
        }
        is TdlResult.Success -> {
            val authorizationState = result.result
            // TODO
        }
    }
}

Tip

You can use the .toResult() extension to convert TdlResult<T> to the standard Kotlin Result<T> type.