spotify-api-kotlin/com.adamratzman.spotify.auth/SpotifyDefaultCredentialStore

SpotifyDefaultCredentialStore

class SpotifyDefaultCredentialStore(clientId: String, redirectUri: String, applicationContext: Context)(source)

Provided credential store for holding current Spotify token credentials, allowing you to easily store and retrieve Spotify tokens. Recommended in most use-cases.

Parameters

clientId

The client id associated with your application

applicationContext

The application context - you can obtain this by storing your application context statically (such as with a companion object)

Constructors

SpotifyDefaultCredentialStore

constructor(clientId: String, redirectUri: String, applicationContext: Context)

Types

Companion

object Companion

Properties

credentialTypeStored

var credentialTypeStored: CredentialType?

currentSpotifyPkceCodeVerifier

var currentSpotifyPkceCodeVerifier: String?

Get/set the current Spotify PKCE code verifier.

encryptedPreferences

val encryptedPreferences: SharedPreferences

The EncryptedSharedPreferences that this API saves to/retrieves from.

spotifyAccessToken

var spotifyAccessToken: String?

Get/set the Spotify access token (the access token string, not the wrapped Token).

spotifyRefreshToken

var spotifyRefreshToken: String?

Get/set the Spotify refresh token.

spotifyScopeString

var spotifyScopeString: String?

Get/set the Spotify scope string.

spotifyToken

var spotifyToken: Token?

Get/set the Spotify Token obtained from spotifyToken. If the token has expired according to spotifyTokenExpiresAt, this will return null.

spotifyTokenExpiresAt

var spotifyTokenExpiresAt: Long?

Get/set when the Spotify access token will expire, in milliseconds from UNIX epoch. This will be one hour from authentication.

Functions

canApiBeRefreshed

fun canApiBeRefreshed(): Boolean

Returns whether the Token stored in this Credential Store is refreshable (whether there is a refresh token associated with it).

clear

fun clear(): Boolean

Clear the SharedPreferences instance corresponding to the Spotify credentials.

getSpotifyClientPkceApi

suspend fun getSpotifyClientPkceApi(block: SpotifyApiOptions.() -> Unit? = null): SpotifyClientApi?

Create a new SpotifyClientApi instance using the spotifyToken stored using this credential store.

getSpotifyImplicitGrantApi

fun getSpotifyImplicitGrantApi(block: SpotifyApiOptions.() -> Unit? = null): SpotifyImplicitGrantApi?

Create a new SpotifyImplicitGrantApi instance using the spotifyToken stored using this credential store.

setSpotifyApi

fun setSpotifyApi(api: GenericSpotifyApi)

Sets spotifyToken using SpotifyApi.token. This wraps around spotifyToken's setter.