SpotifyAppApi

class SpotifyAppApi : SpotifyApi<SpotifyAppApi, SpotifyAppApiBuilder>

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

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

open override fun getApiBuilder(): SpotifyApiBuilder

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

getApiBuilderDsl

common

open override fun getApiBuilderDsl(): SpotifyAppApiBuilder

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

getPkceAuthorizationUrl

common

fun getPkceAuthorizationUrl(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.

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

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

useLogger

common

fun useLogger(enable: Boolean)

Allows enabling and disabling the logger

Properties

albums

common

open override val albums: AlbumApi

Provides access to Spotify album endpoints

artists

common

open override val artists: ArtistApi

Provides access to Spotify artist endpoints

browse

common

open override 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

open override val endpoints: List<SpotifyEndpoint>

A list of all endpoints included in this api type

expireTime

common

val expireTime: Long

following

common

open override val following: FollowingApi

Provides access to public playlist follower information

logger

common

val logger: SpotifyLogger

playlists

common

open override val playlists: PlaylistApi

Provides access to public Spotify playlist endpoints

runExecutableFunctions

common

var runExecutableFunctions: Boolean

common

open override val search: SearchApi

Provides access to the Spotify search endpoint

spotifyApiOptions

common

var spotifyApiOptions: SpotifyApiOptions

Configurable Spotify API options.

token

common

var token: Token

The access token associated with this API instance

tracks

common

open override val tracks: TrackApi

Provides access to Spotify track endpoints

useCache

common

var useCache: Boolean

users

common

open override val users: UserApi

Provides access to public Spotify user information

Sources

(source)