com.drivemode.spotify

Class SpotifyApi

java.lang.Object

com.drivemode.spotify.SpotifyApi

public class SpotifyApi
extends java.lang.Object

Singleton object to deal with Spotify Web API and user authorization. First you need to initialize the singleton in your Application. After the initialization, you can access the singleton instance via getInstance(). Basic Usage: - If you need to authorize user, use authorize(android.content.Context, String[]). - If you are to access Web API, use getApiService(). Service object is generated by Retrofit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpotifyApi.AuthenticationListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Method Summary

Modifier and Type	Method and Description
void	authorize(android.content.Context context, java.lang.String[] scopes) Start user's authorization.
void	authorize(android.content.Context context, java.lang.String[] scopes, boolean showDialog) Start user's authorization.
void	blockingRefreshTokenIfNeeded() Refresh access token in the same thread.
static void	destroy() Terminate singleton instance lifetime.
SpotifyService	getApiService()
SpotifyAuthenticateService	getAuthService()
ClientConfig	getConfig()
static SpotifyApi	getInstance()
AccessTokenStore	getTokenStore()
static void	initialize(android.app.Application application, ClientConfig config) Initialize the singleton instance of this class.
boolean	isAuthrorized()
void	onCallback(android.net.Uri data, SpotifyApi.AuthenticationListener listener) Call this method if user back to the activity which can handle the callback.
void	refreshTokenIfNeeded(SpotifyApi.AuthenticationListener listener) Refresh access token in the background thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

Method Detail

initialize

public static void initialize(@NonNull
                              android.app.Application application,
                              @NonNull
                              ClientConfig config)

Initialize the singleton instance of this class.

Parameters:

application - the application.

config - your Spotify API configuration.

getInstance

public static SpotifyApi getInstance()

destroy

public static void destroy()

Terminate singleton instance lifetime.

getApiService

public SpotifyService getApiService()

Returns:

The SpotifyService instance to access Web API

getAuthService

public SpotifyAuthenticateService getAuthService()

Returns:

The SpotifyAuthenticateService instance to access Authorization API

isAuthrorized

public boolean isAuthrorized()

Returns:

true if user already authorized.

authorize

public void authorize(android.content.Context context,
                      java.lang.String[] scopes)

Start user's authorization.

Parameters:

context - the context.

scopes - the scopes you need.

authorize

public void authorize(android.content.Context context,
                      java.lang.String[] scopes,
                      boolean showDialog)

Start user's authorization.

Parameters:

context - the context, should be Activity context.

scopes - the scopes you need.

showDialog - set true if you always need to show prompt.

onCallback

public void onCallback(android.net.Uri data,
                       SpotifyApi.AuthenticationListener listener)

Call this method if user back to the activity which can handle the callback. Callback should pass the data as Uri for Activity.onNewIntent(android.content.Intent), so keep in mind that your callback activity should be singleton in the back stack.

Parameters:

data - the data in the Intent passed to your callback Activity

listener - callback listener that is invoked when the access token is retrieved

refreshTokenIfNeeded

public void refreshTokenIfNeeded(SpotifyApi.AuthenticationListener listener)

Refresh access token in the background thread.

blockingRefreshTokenIfNeeded

public void blockingRefreshTokenIfNeeded()

Refresh access token in the same thread.

getConfig

public ClientConfig getConfig()

getTokenStore

public AccessTokenStore getTokenStore()