• Home
• de.jsone-studios
• spotify-web-api-java
• 1.3.3
• source code
• PlaylistTracksSpotifyService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

de.jsone_studios.wrapper.spotify.services.PlaylistTracksSpotifyService Maven / Gradle / Ivy

package de.jsone_studios.wrapper.spotify.services;

import de.jsone_studios.wrapper.spotify.models.*;
import retrofit2.Call;
import retrofit2.http.*;

import java.util.Map;

public interface PlaylistTracksSpotifyService
{
    /**
     * Add tracks to a playlist
     *
     * @param playlistId      The playlist's ID
     * @param queryParameters Query parameters
     * @return A snapshot ID (the version of the playlist)
     * @see Add Tracks to a Playlist
     */
    @POST("playlists/{playlist_id}/tracks")
    Call addTracksToPlaylist(@Path("playlist_id") String playlistId, @QueryMap Map queryParameters);

    /**
     * Add tracks to a playlist
     *
     * @param playlistId  The playlist's ID
     * @param tracksToAdd The tracks to add as list of track uris. A maximum of 100 tracks can be added in one request.
     * @return A snapshot ID (the version of the playlist)
     * @see Add Tracks to a Playlist
     */
    @POST("playlists/{playlist_id}/tracks")
    Call addTracksToPlaylist(@Path("playlist_id") String playlistId, @Body PlaylistTracksToAdd tracksToAdd);

    /**
     * Add tracks to a playlist
     *
     * @param playlistId  The playlist's ID
     * @param tracksToAddWithPosition The tracks to add as list of track uris and the position to add the track.
     *                                A maximum of 100 tracks can be added in one request.
     * @return A snapshot ID (the version of the playlist)
     * @see Add Tracks to a Playlist
     */
    @POST("playlists/{playlist_id}/tracks")
    Call addTracksToPlaylist(@Path("playlist_id") String playlistId, @Body PlaylistTracksToAddWithPosition tracksToAddWithPosition);

    /**
     * Get full details of the tracks of a playlist owned by a Spotify user.
     *
     * @param playlistId The Spotify ID for the playlist.
     * @return List of playlist's tracks wrapped in a {@code Pager} object
     * @see Get a Playlist’s Tracks
     */
    @GET("playlists/{playlist_id}/tracks")
    Call> getPlaylistTracks(@Path("playlist_id") String playlistId);

    /**
     * Get full details of the tracks of a playlist owned by a Spotify user.
     *
     * @param playlistId The Spotify ID for the playlist.
     * @param options    Optional parameters. For list of supported parameters see
     *                   endpoint documentation
     * @return List of playlist's tracks wrapped in a {@code Pager} object
     * @see Get a Playlist’s Tracks
     */
    @GET("playlists/{playlist_id}/tracks")
    Call> getPlaylistTracks(@Path("playlist_id") String playlistId, @QueryMap Map options);

    /**
     * Remove one or more tracks from a user’s playlist.
     *
     * @param playlistId     The playlist's Id
     * @param tracksToRemove A list of tracks to remove. A maximum of 100 objects can be sent at once.
     * @return A snapshot ID (the version of the playlist)
     * @see Remove Tracks from a Playlist
     */
    @HTTP(method = "DELETE", hasBody = true, path = "playlists/{playlist_id}/tracks")
    Call removeTracksFromPlaylist(@Path("playlist_id") String playlistId, @Body PlaylistTracksToRemove tracksToRemove);

    /**
     * Remove one or more tracks from a user’s playlist.
     *
     * @param playlistId                 The playlist's Id
     * @param tracksToRemoveWithPosition A list of tracks to remove, together with their specific positions.
     *                                   A maximum of 100 objects can be sent at once.
     * @return A snapshot ID (the version of the playlist)
     * @see Remove Tracks from a Playlist
     */
    @HTTP(method = "DELETE", hasBody = true, path = "playlists/{playlist_id}/tracks")
    Call removeTracksFromPlaylist(@Path("playlist_id") String playlistId, @Body PlaylistTracksToRemoveWithPosition tracksToRemoveWithPosition);

    /**
     * Replace all the tracks in a playlist, overwriting its existing tracks. This powerful request can be useful for
     * replacing tracks, re-ordering existing tracks, or clearing the playlist.
     *
     * @param playlistId The playlist's Id
     * @param trackUris  A list of comma-separated track uris. A maximum of 100 tracks can be set in one request.
     * @return An empty result
     * @see Replace a Playlist’s Tracks
     */
    @PUT("playlists/{playlist_id}/tracks")
    Call replaceTracksInPlaylist(@Path("playlist_id") String playlistId, @Query("uris") String trackUris);

    /**
     * Replace all the tracks in a playlist, overwriting its existing tracks. This powerful request can be useful for
     * replacing tracks, re-ordering existing tracks, or clearing the playlist.
     *
     * @param playlistId The playlist's Id
     * @param newTracksToSet A list of track uris. A maximum of 100 tracks can be set in one request.
     * @return An empty result
     * @see Replace a Playlist’s Tracks
     */
    @PUT("playlists/{playlist_id}/tracks")
    Call replaceTracksInPlaylist(@Path("playlist_id") String playlistId, @Body PlaylistTracksToReplace newTracksToSet);

    /**
     * Reorder a Playlist's tracks
     *
     * @param playlistId The Spotify ID of the playlist
     * @param body       The body parameters. For list of supported parameters see endpoint documentation
     * @return A snapshot ID (the version of the playlist)
     * @see Reorder a Playlist
     */
    @PUT("playlists/{playlist_id}/tracks")
    Call reorderPlaylistTracks(@Path("playlist_id") String playlistId, @Body Map body);
}