Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApiConfig

Index

Properties

Optional authType

authType: undefined | "TOKEN" | "CODE"

(Android) Choose the response type CODE or TOKEN. Useful to determine if you need a on time login or a longterm login.

memberof

SpotifyApiConfig

clientID

clientID: string

Client Id of application registered with Spotify Api see https://developer.spotify.com/dashboard/applications

memberof

SpotifyApiConfig

Optional playURI

playURI: undefined | string

URI of Spotify item to play upon authorization. "" will attempt to resume playback from where it was.

Note: If Spotify is already open and playing, this parameter will not have any effect

memberof

SpotifyApiConfig

redirectURL

redirectURL: string

The redirect url back to your application (i.e. myapp://spotify-login-callback )

memberof

SpotifyApiConfig

Optional scopes

scopes: undefined | ApiScope[]

Requested API Scopes, need to have AppRemoteControlScope to control playback of app

memberof

SpotifyApiConfig

Optional showDialog

showDialog: undefined | boolean

Whether or not the auth dialog should be shown. Useful for debugging auth flows.

memberof

SpotifyApiConfig

Optional tokenRefreshURL

tokenRefreshURL: undefined | string

Endpoint on your server to refesh token

memberof

SpotifyApiConfig

Optional tokenSwapURL

tokenSwapURL: undefined | string

Endpoint on your server to do token swap

memberof

SpotifyApiConfig

Legend

  • Property
  • Method

Generated using TypeDoc