shared/com.nubasu.spotify.webapi.wrapper.api.authorization/SpotifyAuthManager

SpotifyAuthManager

class SpotifyAuthManager(clientId: String, clientSecret: String? = null, redirectUri: String? = null, authorizationApis: AuthorizationApis = AuthorizationApis(), authorizationUriLauncher: (String) -> Boolean = ::launchAuthorizationUriOnPlatform)

High-level authorization manager for Spotify Accounts flows.

Handles PKCE state/verifier lifecycle, code exchange, token refresh, and token caching.

Constructors

SpotifyAuthManager

constructor(clientId: String, clientSecret: String? = null, redirectUri: String? = null, authorizationApis: AuthorizationApis = AuthorizationApis(), authorizationUriLauncher: (String) -> Boolean = ::launchAuthorizationUriOnPlatform)

Functions

buildAuthorizationCodeUri

fun buildAuthorizationCodeUri(scope: List<String> = emptyList(), state: String? = null, showDialog: Boolean? = null): String

Builds the Spotify authorization URL for Authorization Code flow.

buildAuthorizationCodeUriAndLaunch

fun buildAuthorizationCodeUriAndLaunch(scope: List<String> = emptyList(), state: String? = null, showDialog: Boolean? = null): String

Builds and launches the Spotify authorization URL for Authorization Code flow.

buildAuthorizationCodeWithPkceUri

fun buildAuthorizationCodeWithPkceUri(codeChallenge: String, codeChallengeMethod: String = "S256", scope: List<String> = emptyList(), state: String? = null, showDialog: Boolean? = null): String

Builds the Spotify authorization URL for Authorization Code with PKCE flow.

buildAuthorizationCodeWithPkceUriAndLaunch

fun buildAuthorizationCodeWithPkceUriAndLaunch(codeChallenge: String, codeChallengeMethod: String = "S256", scope: List<String> = emptyList(), state: String? = null, showDialog: Boolean? = null): String

Builds and launches the Spotify authorization URL for PKCE flow.

clearToken

fun clearToken()

Clears the currently stored token and expiration state.

completePkceAuthorization

suspend fun completePkceAuthorization(code: String, returnedState: String): TokenResponse

Completes PKCE authorization by exchanging the authorization code.

completePkceAuthorizationFromRedirectUri

suspend fun completePkceAuthorizationFromRedirectUri(redirectedUri: String): TokenResponse

Completes PKCE authorization by parsing the Spotify callback URI and exchanging the code.

exchangeAuthorizationCode

suspend fun exchangeAuthorizationCode(code: String): TokenResponse

Exchanges an authorization code for tokens and stores the token set.

exchangeAuthorizationCodeWithPkce

suspend fun exchangeAuthorizationCodeWithPkce(code: String, codeVerifier: String): TokenResponse

Exchanges an authorization code for tokens using PKCE and stores the token set.

getCurrentToken

fun getCurrentToken(): TokenResponse?

Returns the currently stored token response.

getValidAccessToken

suspend fun getValidAccessToken(leewaySeconds: Int = 60, autoRefresh: Boolean = true): String

Returns a valid access token, refreshing it when necessary.

launchAuthorizationInAppOrBrowser

fun launchAuthorizationInAppOrBrowser(authorizationUri: String): Boolean

Launches the Spotify authorization URL using in-app auth UI or browser.

refreshAccessToken

suspend fun refreshAccessToken(): TokenResponse

Refreshes the current access token using the stored refresh token.

requestClientCredentialsToken

suspend fun requestClientCredentialsToken(): TokenResponse

Requests a client-credentials token and stores the token set.

startPkceAuthorization

fun startPkceAuthorization(scope: List<String> = emptyList(), showDialog: Boolean? = null): PkceAuthorizationRequest

Starts Authorization Code with PKCE flow and returns authorization request data.

startPkceAuthorizationAndLaunch

fun startPkceAuthorizationAndLaunch(scope: List<String> = emptyList(), showDialog: Boolean? = null): PkceAuthorizationRequest

Starts Authorization Code with PKCE flow and launches the authorization URL.

startPkceAuthorizationAsync

suspend fun startPkceAuthorizationAsync(scope: List<String> = emptyList(), showDialog: Boolean? = null): PkceAuthorizationRequest

Starts Authorization Code with PKCE flow asynchronously.

startPkceAuthorizationAsyncAndLaunch

suspend fun startPkceAuthorizationAsyncAndLaunch(scope: List<String> = emptyList(), showDialog: Boolean? = null): PkceAuthorizationRequest

Starts Authorization Code with PKCE flow asynchronously and launches the authorization URL.