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

Create a client

val client = TdlClient.create()

Subscribe to updates

TdlClient provides 189 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 1022 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
        }
    }
}