SpotifyAppApiBuilder

class SpotifyAppApiBuilder(credentials: SpotifyCredentials, authorization: SpotifyUserAuthorization, options: SpotifyApiOptions) : ISpotifyAppApiBuilder

SpotifyAppApi builder for api creation using client authorization

Constructors

common

fun SpotifyAppApiBuilder(credentials: SpotifyCredentials = SpotifyCredentials(), authorization: SpotifyUserAuthorization = SpotifyUserAuthorization(), options: SpotifyApiOptions = SpotifyApiOptions())

Functions

authentication

common

open fun authentication(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<SpotifyAppApi, SpotifyAppApiBuilder>

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<SpotifyAppApi, SpotifyAppApiBuilder>

open fun authorization(block: SpotifyUserAuthorization.() -> Unit): ISpotifyApiBuilder<SpotifyAppApi, SpotifyAppApiBuilder>

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

Build a public SpotifyAppApi using the provided credentials

buildRestAction

common

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

Build the T by provided information

credentials

common

open fun credentials(block: SpotifyCredentials.() -> Unit): ISpotifyApiBuilder<SpotifyAppApi, SpotifyAppApiBuilder>

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

options

common

open fun options(options: SpotifyApiOptions): ISpotifyApiBuilder<SpotifyAppApi, SpotifyAppApiBuilder>

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

open fun options(block: SpotifyApiOptions.() -> Unit): ISpotifyApiBuilder<SpotifyAppApi, SpotifyAppApiBuilder>

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

Sources

common source