spotify-api-kotlin/com.adamratzman.spotify/SpotifyApi

SpotifyApi

sealed class SpotifyApi<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>>(source)

Represents an instance of the Spotify API client, with common functionality and information between the SpotifyClientApi and SpotifyAppApi implementations of the API

Parameters

clientId

The application client id found on the application dashboard

clientSecret

The application client secret found on the application dashboard

token

The access token associated with this API instance

spotifyApiOptions

Configurable Spotify API options.

Inheritors

SpotifyAppApi

SpotifyClientApi

Types

Companion

object Companion

Properties

albums

abstract val albums: AlbumApi

Provides access to Spotify album endpoints

artists

abstract val artists: ArtistApi

Provides access to Spotify artist endpoints

browse

abstract val browse: BrowseApi

Provides access to Spotify browse endpoints

clientId

val clientId: String?

clientSecret

val clientSecret: String?

endpoints

abstract val endpoints: List<SpotifyEndpoint>

A list of all endpoints included in this api type

episodes

abstract val episodes: EpisodeApi

Provides access to Spotify episode endpoints

expireTime

val expireTime: Long

following

abstract val following: FollowingApi

markets

abstract val markets: MarketsApi

Provides access to Spotify market endpoints

playlists

abstract val playlists: PlaylistApi

runExecutableFunctions

var runExecutableFunctions: Boolean

abstract val search: SearchApi

Provides access to the Spotify search endpoint

shows

abstract val shows: ShowApi

Provides access to Spotify show endpoints

spotifyApiOptions

var spotifyApiOptions: SpotifyApiOptions

token

var token: Token

tracks

abstract val tracks: TrackApi

Provides access to Spotify track endpoints

useCache

var useCache: Boolean

users

abstract val users: UserApi

Functions

clearCache

fun clearCache()

If the cache is enabled, clear all stored queries in the cache

getApiBuilder

abstract fun getApiBuilder(): SpotifyApiBuilder

Return a new SpotifyApiBuilder with the parameters provided to this api instance

getApiBuilderDsl

abstract fun getApiBuilderDsl(): B

Return a new B with the parameters provided to this api instance

getAuthorizationUrl

fun getAuthorizationUrl(vararg scopes: SpotifyScope, redirectUri: String, state: String? = null): String

Create a Spotify authorization URL from which client access can be obtained

getCache

fun getCache(): Map<SpotifyRequest, CacheState>

Obtain a map of all currently-cached requests

getSpotifyPkceAuthorizationUrl

fun getSpotifyPkceAuthorizationUrl(vararg scopes: SpotifyScope, redirectUri: String, codeChallenge: String, state: String? = null): String

isTokenValid

@JvmOverloads

suspend fun isTokenValid(makeTestRequest: Boolean = true): TokenValidityResponse

Tests whether the current token is actually valid. By default, an endpoint is called once to verify validity.

isTokenValidRestAction

@JvmOverloads

fun isTokenValidRestAction(makeTestRequest: Boolean = true): SpotifyRestAction<TokenValidityResponse>

Tests whether the current token is actually valid. By default, an endpoint is called once to verify validity.

refreshToken

suspend fun refreshToken(): Token

If the method used to create the token supports token refresh and the information in token is accurate, attempt to refresh the token

refreshTokenRestAction

fun refreshTokenRestAction(): SpotifyRestAction<Token>

If the method used to create the token supports token refresh and the information in token is accurate, attempt to refresh the token

updateToken

fun updateToken(modifier: Token.() -> Unit)

Modify the current Token via DSL

updateTokenWith

fun updateTokenWith(tokenString: String)

Change the current Token's access token