ISpotifyClientApiBuilder

interface ISpotifyClientApiBuilder : ISpotifyApiBuilder<SpotifyClientApi, SpotifyClientApiBuilder>

Client interface exposing getAuthorizationUrl

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

abstract suspend fun build(enableDefaultTokenRefreshProducerIfNoneExists: Boolean = true): 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

abstract fun getAuthorizationUrl(vararg scopes: SpotifyScope, state: String? = null): 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

abstract var authorization: SpotifyUserAuthorization

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

credentials

common

abstract var credentials: SpotifyCredentials

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

options

common

abstract var options: SpotifyApiOptions

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

Inheritors

SpotifyClientApiBuilder

Sources

common source