ISpotifyApiBuilder

interface ISpotifyApiBuilder<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>>

Spotify Api builder interface

Parameters

The type of SpotifyApi to be built

The associated Api builder for T

Functions

authentication

common

open fun authentication(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<T, B>

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<T, B>

open fun authorization(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<T, B>

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): T

Build the T by provided information

buildRestAction

common

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

Build the T by provided information

credentials

common

open fun credentials(block: SpotifyCredentials.() -> Unit): ISpotifyApiBuilder<T, B>

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

options

common

open fun options(options: SpotifyApiOptions): ISpotifyApiBuilder<T, B>

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

open fun options(block: SpotifyApiOptions.() -> Unit): ISpotifyApiBuilder<T, B>

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

ISpotifyClientApiBuilder

ISpotifyAppApiBuilder

Sources

common source