SpotifyClientApiBuilder

class SpotifyClientApiBuilder(credentials: SpotifyCredentials, authorization: SpotifyUserAuthorization, options: SpotifyApiOptions, usesPkceAuth: Boolean?) : ISpotifyClientApiBuilder

SpotifyClientApi builder for api creation using client authorization

Parameters

usesPkceAuth

Set this if PKCE authorization is used to build this API. Note: this is not required to be true if SpotifyUserAuthorization.pkceCodeVerifier (options.pkceCodeVerifier) is set. If options.pkceCodeVerifier, this builder will always build a Spotify client api with PKCE auth.

Constructors

SpotifyClientApiBuilder

common

fun SpotifyClientApiBuilder(credentials: SpotifyCredentials = SpotifyCredentials(), authorization: SpotifyUserAuthorization = SpotifyUserAuthorization(), options: SpotifyApiOptions = SpotifyApiOptions(), usesPkceAuth: Boolean? = null)

Set this if PKCE authorization is used to build this API.

Functions

authentication

common

open fun authentication(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

Allows you to authenticate a SpotifyClientApi with an authorization code or build SpotifyApi using a refresh token

authorization

common

open fun authorization(authorization: SpotifyUserAuthorization): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

open fun authorization(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

Allows you to authenticate a SpotifyClientApi with an authorization code or build SpotifyApi using a refresh token

build

common

open suspend override fun build(enableDefaultTokenRefreshProducerIfNoneExists: Boolean): SpotifyClientApi

Build the T by provided information

buildRestAction

common

open fun buildRestAction(enableDefaultTokenRefreshProducerIfNoneExists: Boolean = true): SpotifyRestAction<SpotifyClientApi>

Build the T by provided information

credentials

common

open fun credentials(block: SpotifyCredentials.() -> Unit): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

A block in which Spotify application credentials (accessible via the Spotify dashboard) should be put

getAuthorizationUrl

common

open override fun getAuthorizationUrl(vararg scopes: SpotifyScope, state: String?): String

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

options

common

open fun options(options: SpotifyApiOptions): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

Allows you to override default values for caching, token refresh, and logging

open fun options(block: SpotifyApiOptions.() -> Unit): ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

Allows you to override default values for caching, token refresh, and logging

Properties

authorization

common

open override var authorization: SpotifyUserAuthorization

Allows you to authenticate a SpotifyClientApi with an authorization code or build SpotifyApi using a refresh token

credentials

common

open override var credentials: SpotifyCredentials

A block in which Spotify application credentials (accessible via the Spotify dashboard) should be put

options

common

open override var options: SpotifyApiOptions

Allows you to override default values for caching, token refresh, and logging

usesPkceAuth

common

var usesPkceAuth: Boolean? = null

Set this if PKCE authorization is used to build this API.

Sources

common source