tabroom-api/dev.gmitch215.tabroom.util/login

login

@JvmName(name = "loginAsync")

suspend fun login(username: String, password: String): Boolean

Logs in to Tabroom with the given username and password.

This function performs a login request to Tabroom and stores the authentication token in the token variable. Tokens represent the Session ID and are valid for 1,024 hours, or roughly 42 days.

If the API is already logged in, it will log out and then log in again.

Return

True if the login was successful, false otherwise.

Parameters

username

The username to log in with.

password

The password to log in with.

Throws

IOException

If the login request fails.