com.spotify.android.appremote.api

Interface UserApi

public interface UserApi

Get user-related data and perform actions related to current user Get an instance of an UserApi with SpotifyAppRemote.getUserApi().

See Also:

SpotifyAppRemote

Method Summary

Modifier and Type	Method and Description
CallResult<Empty>	addToLibrary(java.lang.String uri) Adds item to users' library.
CallResult<Capabilities>	getCapabilities() Get the Capabilities of a current user.
CallResult<LibraryState>	getLibraryState(java.lang.String uri) Gets library state for the given Spotify uri.
CallResult<Empty>	removeFromLibrary(java.lang.String uri) Removes item from users library.
Subscription<Capabilities>	subscribeToCapabilities() Same as getCapabilities(), but subscription.
Subscription<UserStatus>	subscribeToUserStatus()

Method Detail

getCapabilities

CallResult<Capabilities> getCapabilities()

Get the Capabilities of a current user. It is useful to call before you make call to PlayerApi.play(String):

  userApi.getCapabilities()
    .setResultCallback( capabilities ->
      if (capabilities.canPlayOnDemand) {
          playerApi.play(trackUri);
      } else {
          // current user is not able to play on demand
      }
 )
 
 

Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1

Returns:

CallResult with Capabilities of a current user

subscribeToCapabilities

Subscription<Capabilities> subscribeToCapabilities()

Same as getCapabilities(), but subscription. Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1

Returns:

Subscription to Capabilities of a current user

subscribeToUserStatus

Subscription<UserStatus> subscribeToUserStatus()

addToLibrary

CallResult<Empty> addToLibrary(java.lang.String uri)

Adds item to users' library. Supported uris currently include: Track - example: spotify:track:6rqhFgbbKwnb9MLmUQDhG6 Album - example: spotify:album:2VYSDvc0ZdcfkXDcYVjHs6 Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1

Parameters:

uri - to get saved state for

Returns:

a pending call result that can be used to track the success/failure of this command

removeFromLibrary

CallResult<Empty> removeFromLibrary(java.lang.String uri)

Removes item from users library. Supported uris currently include: Track - example: spotify:track:6rqhFgbbKwnb9MLmUQDhG6 Album - example: spotify:album:2VYSDvc0ZdcfkXDcYVjHs6 Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1

Parameters:

uri - to get saved state for

Returns:

a pending call result that can be used to track the success/failure of this command

getLibraryState

CallResult<LibraryState> getLibraryState(java.lang.String uri)

Gets library state for the given Spotify uri. Supported uris currently include: Track - example: spotify:track:6rqhFgbbKwnb9MLmUQDhG6 Album - example: spotify:album:2VYSDvc0ZdcfkXDcYVjHs6 Introduced in com.spotify.protocol.client.RequiredFeatures#FEATURES_V1

Parameters:

uri - track or album to get library state for

Returns:

LibraryState of a given uri.