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

ISpotifyApiBuilder

interface ISpotifyApiBuilder<T : SpotifyApi<T, B>, B : ISpotifyApiBuilder<T, B>>(source)

Spotify Api builder interface

Parameters

T

The type of SpotifyApi to be built

B

The associated Api builder for T

Inheritors

Properties

Link copied to clipboard
abstract var authorization: SpotifyUserAuthorization

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

Link copied to clipboard
abstract var credentials: SpotifyCredentials

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

Link copied to clipboard
abstract var options: SpotifyApiOptions

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

Functions

Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
abstract suspend fun build(enableDefaultTokenRefreshProducerIfNoneExists: Boolean = true): T

Build the T by provided information

Link copied to clipboard
open fun buildRestAction(enableDefaultTokenRefreshProducerIfNoneExists: Boolean = true): SpotifyRestAction<T>

Build the T by provided information

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

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

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

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