SpotifyDefaultCredentialStore

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

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

android

fun SpotifyDefaultCredentialStore(clientId: String, redirectUri: String, applicationContext: Context)

The client id associated with your application

Types

Companion

android

object Companion

Functions

canApiBeRefreshed

android

fun canApiBeRefreshed(): Boolean

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

clear

android

fun clear(): Boolean

Clear the SharedPreferences instance corresponding to the Spotify credentials.

equals

android

open operator fun equals(other: Any?): Boolean

getSpotifyClientPkceApi

android

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

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

getSpotifyImplicitGrantApi

android

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

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

hashCode

android

open fun hashCode(): Int

setSpotifyApi

android

fun setSpotifyApi(api: GenericSpotifyApi)

Sets spotifyToken using SpotifyApi.token.

toString

android

open fun toString(): String

Properties

credentialTypeStored

android

var credentialTypeStored: CredentialType? = null

encryptedPreferences

android

val encryptedPreferences: SharedPreferences

The EncryptedSharedPreferences that this API saves to/retrieves from.

spotifyAccessToken

android

var spotifyAccessToken: String?

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

spotifyRefreshToken

android

var spotifyRefreshToken: String?

Get/set the Spotify refresh token.

spotifyToken

android

var spotifyToken: Token?

Get/set the Spotify Token obtained from spotifyToken.

spotifyTokenExpiresAt

android

var spotifyTokenExpiresAt: Long?

Get/set when the Spotify access token will expire, in milliseconds from UNIX epoch.

Sources

(source)