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

SpotifyClientApi

open class SpotifyClientApi(clientId: String?, clientSecret: String?, var redirectUri: String?, token: Token, val usesPkceAuth: Boolean, enableDefaultTokenRefreshProducerIfNoneExists: Boolean, spotifyApiOptions: SpotifyApiOptions) : SpotifyApi<SpotifyClientApi, SpotifyClientApiBuilder> (source)

An API instance created through client authentication, with access to private information managed through the scopes exposed in token

Inheritors

SpotifyImplicitGrantApi

Constructors

SpotifyClientApi

constructor(clientId: String?, clientSecret: String?, token: Token, spotifyApiOptions: SpotifyApiOptions)

constructor(clientId: String?, clientSecret: String?, redirectUri: String?, token: Token, usesPkceAuth: Boolean, enableDefaultTokenRefreshProducerIfNoneExists: Boolean, spotifyApiOptions: SpotifyApiOptions)

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: ClientEpisodeApi

Provides access to Spotify episode endpoints

expireTime

val expireTime: Long

following

open override val following: ClientFollowingApi

Provides access to endpoints for managing the artists, users, and playlists that a Spotify user follows. Superset of FollowingApi

library

val library: ClientLibraryApi

Provides access to endpoints for retrieving information about, and managing, tracks that the current user has saved in their “Your Music” library.

markets

open override val markets: MarketsApi

Provides access to Spotify market endpoints

personalization

val personalization: ClientPersonalizationApi

Provides access to endpoints for retrieving information about the user’s listening habits.

player

val player: ClientPlayerApi

Provides access to the beta player api, including track playing and pausing endpoints.

playlists

open override val playlists: ClientPlaylistApi

Provides access to endpoints for retrieving information about a user’s playlists and for managing a user’s playlists. Superset of PlaylistApi

redirectUri

var redirectUri: String?

runExecutableFunctions

var runExecutableFunctions: Boolean

open override val search: SearchApi

Provides access to the Spotify search endpoint

shows

open override val shows: ClientShowApi

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: ClientProfileApi

Provides access to endpoints for retrieving information about a user’s profile. Superset of UserApi

usesPkceAuth

val usesPkceAuth: Boolean

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(): SpotifyClientApiBuilder

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

getAuthorizationUrl

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

fun getAuthorizationUrl(vararg scopes: SpotifyScope, 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

getUserId

suspend fun getUserId(): String

The Spotify user id to which the api instance is connected

getUserIdRestAction

fun getUserIdRestAction(): SpotifyRestAction<String>

The Spotify user id to which the api instance is connected

hasScope

suspend fun hasScope(scope: SpotifyScope): Boolean?

Whether the current access token allows access to scope scope

hasScopeRestAction

fun hasScopeRestAction(scope: SpotifyScope): SpotifyRestAction<Boolean?>

Whether the current access token allows access to scope scope

hasScopes

suspend fun hasScopes(scope: SpotifyScope, vararg scopes: SpotifyScope): Boolean?

Whether the current access token allows access to all of the provided scopes

hasScopesRestAction

fun hasScopesRestAction(scope: SpotifyScope, vararg scopes: SpotifyScope): SpotifyRestAction<Boolean?>

Whether the current access token allows access to all of the provided scopes

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

shutdown

fun shutdown()

Stop all automatic functions like refreshToken or clearCache and shut down the scheduled executor

updateToken

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

Modify the current Token via DSL

updateTokenWith

fun updateTokenWith(tokenString: String)

Change the current Token's access token