auth/com.tidal.sdk.auth.model

Package-level declarations

Types

data class AuthConfig(val clientId: String, val clientUniqueKey: String? = null, val clientSecret: String? = null, val credentialsKey: String, val scopes: Set<String> = setOf(), val tidalLoginServiceBaseUrl: String = DEFAULT_LOGIN_SERVICE_BASE_URL, val tidalAuthServiceBaseUrl: String = DEFAULT_AUTH_SERVICE_BASE_URL, val enableCertificatePinning: Boolean = true, val logLevel: NetworkLogLevel = NetworkLogLevel.NONE)

Configuration object for the Auth module.

AuthorizationError

class AuthorizationError(val code: String, val subStatus: Int? = null, val throwable: Throwable? = null) : TidalError

Error indicating that the user did not correctly authenticate themselves at the TIDAL login service. Raised when the URI made to the redirect URI indicates that the authentication was not succesful.

AuthResult

sealed class AuthResult<out T>

Credentials

@Serializable

data class Credentials(val clientId: String, val requestedScopes: Set<String>, val clientUniqueKey: String?, val grantedScopes: Set<String>, val userId: String?, val expires: Instant?, val token: String?)

Represents the credentials of a user or client.

CredentialsUpdatedMessage

data class CredentialsUpdatedMessage(val credentials: Credentials? = null) : TidalMessage

Message sent on the CredentialsProvider.bus when credentials are updated.

DeviceAuthorizationResponse

@Serializable

data class DeviceAuthorizationResponse(val deviceCode: String, val userCode: String, val verificationUri: String, val verificationUriComplete: String?, val expiresIn: Int, val interval: Int)

LoginConfig

data class LoginConfig(val locale: Locale? = Locale.getDefault(), val email: String? = null, val customParams: Set<QueryParameter> = setOf())

Configuration parameters for the TIDAL login service.

QueryParameter

data class QueryParameter(val key: String, val value: String)

Represents a query parameter.

TokenResponseError

class TokenResponseError(val code: String, val subStatus: Int? = null, val throwable: Throwable? = null) : TidalError

Error used to indicate that an access token could not be retrieved.

Functions

failure

fun failure(message: TidalMessage? = null): AuthResult.Failure

Creates a AuthResult.Failure with all fields

success

fun <T> success(data: T?): AuthResult.Success<T & Any>

Creates a AuthResult.Success with data payload