Package-level declarations

Types

Link copied to clipboard
interface Login

Namespace for the login API request and response data classes.

Functions

Link copied to clipboard
suspend fun Umami.login(request: Login.Request): Login.Response

Logs in to the Umami API. After a successful login, the authentication token is stored and used for subsequent requests.

suspend fun Umami.login(username: String, password: String): Login.Response

Logs in to the Umami API. After a successful login, the authentication token is stored and used for subsequent requests. This is a convenience function that creates a Login.Request object.

Link copied to clipboard
suspend fun Umami.logout()

Logs out the current user.

Link copied to clipboard
suspend fun Umami.verify(): User

Verifies the current authentication state of the Umami client.