com.spotify.android.appremote.api

Class SpotifyAppRemote

java.lang.Object

com.spotify.android.appremote.api.SpotifyAppRemote

All Implemented Interfaces:

AppRemote

public class SpotifyAppRemote
extends java.lang.Object
implements AppRemote

Entry point for interacting with the Spotify app using the Spotify App Remote for Android

Method Summary

Modifier and Type	Method and Description
<T extends Item,S extends Item> CallResult<T>	call(java.lang.String uri, S argument, java.lang.Class<T> resultType)
static void	connect(android.content.Context context, ConnectionParams params, Connector.ConnectionListener connectionListener) Connect to get an instance of SpotifyAppRemote.
static void	disconnect(SpotifyAppRemote spotifyAppRemote) Disconnect a SpotifyAppRemote from the Spotify app and release resources.
ConnectApi	getConnectApi()
ContentApi	getContentApi()
ImagesApi	getImagesApi()
PlayerApi	getPlayerApi()
UserApi	getUserApi()
boolean	isConnected()
static boolean	isDebugMode()
static boolean	isSpotifyInstalled(android.content.Context context) Check if a Spotify app is installed on this device
static void	setDebugMode(boolean isDebug) Enable excessive logging.
<T extends Item> Subscription<T>	subscribe(java.lang.String uri, java.lang.Class<T> eventType)

Methods inherited from class java.lang.Object

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

Method Detail

connect

public static void connect(android.content.Context context,
                           ConnectionParams params,
                           Connector.ConnectionListener connectionListener)

Connect to get an instance of SpotifyAppRemote.

Parameters:

context - a valid Android context

params - parameters to identify and configure the connection

connectionListener - a listener that will be called when the connection is successful, fails or is lost

disconnect

public static void disconnect(SpotifyAppRemote spotifyAppRemote)

Disconnect a SpotifyAppRemote from the Spotify app and release resources.

Parameters:

spotifyAppRemote - the SpotifyAppRemote you want to disconnect or null (will do nothing)

getImagesApi

@Nonnull
public ImagesApi getImagesApi()

Specified by:

getImagesApi in interface AppRemote

Returns:

a ImagesApi for fetching images from the Spotify app

getPlayerApi

@Nonnull
public PlayerApi getPlayerApi()

Specified by:

getPlayerApi in interface AppRemote

Returns:

a PlayerApi representation of the Spotify app player

getUserApi

@Nonnull
public UserApi getUserApi()

Specified by:

getUserApi in interface AppRemote

getContentApi

@Nonnull
public ContentApi getContentApi()

Specified by:

getContentApi in interface AppRemote

getConnectApi

@Nonnull
public ConnectApi getConnectApi()

Specified by:

getConnectApi in interface AppRemote

isConnected

public boolean isConnected()

Specified by:

isConnected in interface AppRemote

isSpotifyInstalled

public static boolean isSpotifyInstalled(android.content.Context context)

Check if a Spotify app is installed on this device

Parameters:

context - a valid Android context

Returns:

true if a Spotify app is installed, false otherwise

setDebugMode

public static void setDebugMode(boolean isDebug)

Enable excessive logging. Use only for debugging. Turned off by default

Parameters:

isDebug - set to true to enable debug mode, false to disable

isDebugMode

public static boolean isDebugMode()

Returns:

true if debug mode is enabled

call

@Nonnull
public <T extends Item,S extends Item> CallResult<T> call(@Nullable
                                                                   java.lang.String uri,
                                                                   @Nullable
                                                                   S argument,
                                                                   @Nullable
                                                                   java.lang.Class<T> resultType)

Specified by:

call in interface AppRemote

subscribe

@Nonnull
public <T extends Item> Subscription<T> subscribe(@Nullable
                                                           java.lang.String uri,
                                                           @Nullable
                                                           java.lang.Class<T> eventType)

Specified by:

subscribe in interface AppRemote