SpotifyApiOptions

data class SpotifyApiOptions(useCache: Boolean, cacheLimit: Int?, automaticRefresh: Boolean, retryWhenRateLimited: Boolean, enableLogger: Boolean, testTokenValidity: Boolean, defaultLimit: Int, allowBulkRequests: Boolean, requestTimeoutMillis: Long?, json: Json, refreshTokenProducer: suspend (GenericSpotifyApi) -> Token?, onTokenRefresh: suspend (GenericSpotifyApi) -> Unit?, requiredScopes: List<SpotifyScope>?, proxyBaseUrl: String?, retryIfInternalServerError: Boolean)

API Utilities

Parameters

useCache

Set whether to cache requests. Default: true

cacheLimit

The maximum amount of cached requests allowed at one time. Null means no limit

automaticRefresh

Enable or disable automatic refresh of the Spotify access token

retryWhenRateLimited

Set whether to block the current thread and wait until the API can retry the request

enableLogger

Set whether to enable to the exception logger

testTokenValidity

After API creation, test whether the token is valid by performing a lightweight request

defaultLimit

The default amount of objects to retrieve in one request

json

The Json serializer/deserializer instance

allowBulkRequests

Allow splitting too-large requests into smaller, allowable api requests

requestTimeoutMillis

The maximum time, in milliseconds, before terminating an http request

refreshTokenProducer

Provide if you want to use your own logic when refreshing a Spotify token

onTokenRefresh

Provide if you want to act on token refresh event

requiredScopes

Scopes that your application requires to function (only applicable to SpotifyClientApi and SpotifyImplicitGrantApi).

proxyBaseUrl

Provide if you have a proxy base URL that you would like to use instead of the Spotify API base (https://api.spotify.com/v1).

retryIfInternalServerError

Whether to retry once if an internal server error (500..599) has been received

Constructors

SpotifyApiOptions

common

fun SpotifyApiOptions(useCache: Boolean = true, cacheLimit: Int? = 200, automaticRefresh: Boolean = true, retryWhenRateLimited: Boolean = true, enableLogger: Boolean = true, testTokenValidity: Boolean = false, defaultLimit: Int = 50, allowBulkRequests: Boolean = true, requestTimeoutMillis: Long? = null, json: Json = nonstrictJson, refreshTokenProducer: suspend (GenericSpotifyApi) -> Token? = null, onTokenRefresh: suspend (GenericSpotifyApi) -> Unit? = null, requiredScopes: List<SpotifyScope>? = null, proxyBaseUrl: String? = null, retryIfInternalServerError: Boolean = true)

Set whether to cache requests.

Functions

component1

common

operator fun component1(): Boolean

component10

common

operator fun component10(): Json

component11

common

operator fun component11(): suspend (GenericSpotifyApi) -> Token?

component12

common

operator fun component12(): suspend (GenericSpotifyApi) -> Unit?

component13

common

operator fun component13(): List<SpotifyScope>?

component14

common

operator fun component14(): String?

component15

common

operator fun component15(): Boolean

component2

common

operator fun component2(): Int?

component3

common

operator fun component3(): Boolean

component4

common

operator fun component4(): Boolean

component5

common

operator fun component5(): Boolean

component6

common

operator fun component6(): Boolean

component7

common

operator fun component7(): Int

component8

common

operator fun component8(): Boolean

component9

common

operator fun component9(): Long?

copy

common

fun copy(useCache: Boolean = true, cacheLimit: Int? = 200, automaticRefresh: Boolean = true, retryWhenRateLimited: Boolean = true, enableLogger: Boolean = true, testTokenValidity: Boolean = false, defaultLimit: Int = 50, allowBulkRequests: Boolean = true, requestTimeoutMillis: Long? = null, json: Json = nonstrictJson, refreshTokenProducer: suspend (GenericSpotifyApi) -> Token? = null, onTokenRefresh: suspend (GenericSpotifyApi) -> Unit? = null, requiredScopes: List<SpotifyScope>? = null, proxyBaseUrl: String? = null, retryIfInternalServerError: Boolean = true): SpotifyApiOptions

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String