SpotifyApi

sealed class SpotifyApi<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>>

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.

Types

Companion

common

object Companion

Functions

clearCache

common

fun clearCache()

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

equals

common

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

getApiBuilder

common

abstract fun getApiBuilder(): SpotifyApiBuilder

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

getApiBuilderDsl

common

abstract fun getApiBuilderDsl(): B

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

getAuthorizationUrl

common

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

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

getCache

common

fun getCache(): Map<SpotifyRequest, CacheState>

Obtain a map of all currently-cached requests

getSpotifyPkceAuthorizationUrl

common

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

hashCode

common

open fun hashCode(): Int

isTokenValid

common

@JvmOverloads()

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

Tests whether the current token is actually valid.

isTokenValidRestAction

common

@JvmOverloads()

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

Tests whether the current token is actually valid.

refreshToken

common

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

common

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

toString

common

open fun toString(): String

updateToken

common

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

Modify the current Token via DSL

updateTokenWith

common

fun updateTokenWith(tokenString: String)

Change the current Token's access token

Properties

albums

common

abstract val albums: AlbumApi

Provides access to Spotify album endpoints

artists

common

abstract val artists: ArtistApi

Provides access to Spotify artist endpoints

browse

common

abstract val browse: BrowseApi

Provides access to Spotify browse endpoints

clientId

common

val clientId: String?

The application client id found on the application dashboard

clientSecret

common

val clientSecret: String?

The application client secret found on the application dashboard

endpoints

common

abstract val endpoints: List<SpotifyEndpoint>

A list of all endpoints included in this api type

episodes

common

abstract val episodes: EpisodeApi

Provides access to Spotify episode endpoints

expireTime

common

val expireTime: Long

following

common

abstract val following: FollowingApi

playlists

common

abstract val playlists: PlaylistApi

runExecutableFunctions

common

var runExecutableFunctions: Boolean = true

common

abstract val search: SearchApi

Provides access to the Spotify search endpoint

shows

common

abstract val shows: ShowApi

Provides access to Spotify show endpoints

spotifyApiOptions

common

var spotifyApiOptions: SpotifyApiOptions

Configurable Spotify API options.

token

common

var token: Token

The access token associated with this API instance

tracks

common

abstract val tracks: TrackApi

Provides access to Spotify track endpoints

useCache

common

var useCache: Boolean

users

common

abstract val users: UserApi

Inheritors

SpotifyAppApi

SpotifyClientApi

Sources

(source)