Interface LibrarySpotifyService


  • public interface LibrarySpotifyService
    • Method Detail

      • containsMySavedAlbums

        @GET("me/albums/contains")
        retrofit2.Call<Boolean[]> containsMySavedAlbums​(@Query("ids")
                                                        String ids)
        Check if one or more albums is already saved in the current Spotify user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the albums. Maximum: 50 IDs.
        Returns:
        An array with boolean values that indicate whether the albums are in the current Spotify user’s “Your Music” library.
        See Also:
        Check User’s Saved Albums
      • containsMySavedTracks

        @GET("me/tracks/contains")
        retrofit2.Call<Boolean[]> containsMySavedTracks​(@Query("ids")
                                                        String ids)
        Check if one or more tracks is already saved in the current Spotify user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the tracks. Maximum: 50 IDs.
        Returns:
        An array with boolean values that indicate whether the tracks are in the current Spotify user’s “Your Music” library.
        See Also:
        Check User’s Saved Tracks
      • getMySavedAlbums

        @GET("me/albums")
        retrofit2.Call<Pager<SavedAlbum>> getMySavedAlbums()
        Get a list of the albums saved in the current Spotify user’s “Your Music” library.
        Returns:
        A paginated list of saved albums
        See Also:
        Get a User’s Saved Albums
      • getMySavedAlbums

        @GET("me/albums")
        retrofit2.Call<Pager<SavedAlbum>> getMySavedAlbums​(@QueryMap
                                                           Map<String,​Object> options)
        Get a list of the albums saved in the current Spotify user’s “Your Music” library.
        Parameters:
        options - Optional parameters. For list of supported parameters see endpoint documentation
        Returns:
        A paginated list of saved albums
        See Also:
        Get a User’s Saved Albums
      • getMySavedTracks

        @GET("me/tracks")
        retrofit2.Call<Pager<SavedTrack>> getMySavedTracks()
        Get a list of the songs saved in the current Spotify user’s “Your Music” library.
        Returns:
        A paginated list of saved tracks
        See Also:
        Get a User’s Saved Tracks
      • getMySavedTracks

        @GET("me/tracks")
        retrofit2.Call<Pager<SavedTrack>> getMySavedTracks​(@QueryMap
                                                           Map<String,​Object> options)
        Get a list of the songs saved in the current Spotify user’s “Your Music” library.
        Parameters:
        options - Optional parameters. For list of supported parameters see endpoint documentation
        Returns:
        A paginated list of saved tracks
        See Also:
        Get a User’s Saved Tracks
      • removeFromMySavedAlbums

        @DELETE("me/albums")
        retrofit2.Call<Result> removeFromMySavedAlbums​(@Query("ids")
                                                       String ids)
        Remove one or more albums from the current user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the albums
        Returns:
        An empty result
        See Also:
        Remove User’s Saved Albums
      • removeFromMySavedAlbums

        @DELETE("me/albums")
        retrofit2.Call<Result> removeFromMySavedAlbums​(@Body
                                                       String[] ids)
        Remove one or more albums from the current user’s “Your Music” library.
        Parameters:
        ids - A list of the Spotify IDs for the albums
        Returns:
        An empty result
        See Also:
        Remove User’s Saved Albums
      • removeFromMySavedTracks

        @DELETE("me/tracks")
        retrofit2.Call<Result> removeFromMySavedTracks​(@Query("ids")
                                                       String ids)
        Remove one or more tracks from the current user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the tracks
        Returns:
        An empty result
        See Also:
        Remove User’s Saved Tracks
      • removeFromMySavedTracks

        @DELETE("me/tracks")
        retrofit2.Call<Result> removeFromMySavedTracks​(@Body
                                                       String[] ids)
        Remove one or more tracks from the current user’s “Your Music” library.
        Parameters:
        ids - A list of the Spotify IDs for the tracks
        Returns:
        An empty result
        See Also:
        Remove User’s Saved Tracks
      • addToMySavedAlbums

        @PUT("me/albums")
        retrofit2.Call<Result> addToMySavedAlbums​(@Query("ids")
                                                  String ids)
        Save one or more albums to the current user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the albums
        Returns:
        An empty result
        See Also:
        Save Albums for User
      • addToMySavedAlbums

        @PUT("me/albums")
        retrofit2.Call<Result> addToMySavedAlbums​(@Body
                                                  String[] ids)
        Save one or more albums to the current user’s “Your Music” library.
        Parameters:
        ids - A list of the Spotify IDs for the albums
        Returns:
        An empty result
        See Also:
        Save Albums for User
      • addToMySavedTracks

        @PUT("me/tracks")
        retrofit2.Call<Result> addToMySavedTracks​(@Query("ids")
                                                  String ids)
        Save one or more tracks to the current user’s “Your Music” library.
        Parameters:
        ids - A comma-separated list of the Spotify IDs for the tracks
        Returns:
        An empty result
        See Also:
        Save Tracks for User
      • addToMySavedTracks

        @PUT("me/tracks")
        retrofit2.Call<Result> addToMySavedTracks​(@Body
                                                  String[] ids)
        Save one or more tracks to the current user’s “Your Music” library.
        Parameters:
        ids - A list of the Spotify IDs for the tracks
        Returns:
        An empty result
        See Also:
        Save Tracks for User