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

SpotifyAppApi

class SpotifyAppApi : SpotifyApi<SpotifyAppApi, SpotifyAppApiBuilder> (source)

An API instance created with application credentials, not through client authentication

Types

Companion

object Companion

Properties

albums

open override val albums: AlbumApi

Provides access to Spotify album endpoints

artists

open override val artists: ArtistApi

Provides access to Spotify artist endpoints

browse

open override val browse: BrowseApi

Provides access to Spotify browse endpoints

clientId

val clientId: String?

clientSecret

val clientSecret: String?

endpoints

open override val endpoints: List<SpotifyEndpoint>

A list of all endpoints included in this api type

episodes

open override val episodes: EpisodeApi

Provides access to Spotify episode endpoints

expireTime

val expireTime: Long

following

open override val following: FollowingApi

Provides access to public playlist follower information

markets

open override val markets: MarketsApi

Provides access to Spotify market endpoints

playlists

open override val playlists: PlaylistApi

Provides access to public Spotify playlist endpoints

runExecutableFunctions

var runExecutableFunctions: Boolean

open override val search: SearchApi

Provides access to the Spotify search endpoint

shows

open override val shows: ShowApi

Provides access to Spotify show endpoints

spotifyApiOptions

var spotifyApiOptions: SpotifyApiOptions

token

var token: Token

tracks

open override val tracks: TrackApi

Provides access to Spotify track endpoints

useCache

var useCache: Boolean

users

open override val users: UserApi

Provides access to public Spotify user information

Functions

clearCache

fun clearCache()

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

getApiBuilder

open override fun getApiBuilder(): SpotifyApiBuilder

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

getApiBuilderDsl

open override fun getApiBuilderDsl(): SpotifyAppApiBuilder

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