Package com.wrapper.spotify.requests.data.playlists

Class RemoveTracksFromPlaylistRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<SnapshotResult,RemoveTracksFromPlaylistRequest.Builder>

com.wrapper.spotify.requests.data.playlists.RemoveTracksFromPlaylistRequest.Builder

All Implemented Interfaces:

IRequest.Builder<SnapshotResult,RemoveTracksFromPlaylistRequest.Builder>

Enclosing class:

RemoveTracksFromPlaylistRequest

public static final class RemoveTracksFromPlaylistRequest.Builder
extends AbstractDataRequest.Builder<SnapshotResult,RemoveTracksFromPlaylistRequest.Builder>

Builder class for building a RemoveTracksFromPlaylistRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new RemoveTracksFromPlaylistRequest.Builder.

Method Summary

Modifier and Type	Method	Description
RemoveTracksFromPlaylistRequest	build()	The request build method.
RemoveTracksFromPlaylistRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
protected RemoveTracksFromPlaylistRequest.Builder	self()	Return this instance to simulate a self-type.
RemoveTracksFromPlaylistRequest.Builder	snapshotId(String snapshotId)	The playlist snapshot ID setter.
RemoveTracksFromPlaylistRequest.Builder	tracks(com.google.gson.JsonArray tracks)	The track URIs setter.
RemoveTracksFromPlaylistRequest.Builder	user_id(String user_id)	Deprecated. Playlist IDs are unique for themselves.

Methods inherited from class com.wrapper.spotify.requests.AbstractRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new RemoveTracksFromPlaylistRequest.Builder.

Removing tracks from an user's public playlists requires authorization of the playlist-modify-public scope; removing tracks from an user's private playlist (including collaborative playlists) requires the playlist-modify-private scope.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

See Also:

Spotify: Using Scopes

Method Details

user_id

@Deprecated public RemoveTracksFromPlaylistRequest.Builder user_id(String user_id)

Deprecated.

Playlist IDs are unique for themselves. This parameter is thus no longer used. (https://developer.spotify.com/community/news/2018/06/12/changes-to-playlist-uris/)

The user ID setter.

Parameters:

user_id - The user's Spotify user ID.

Returns:

An RemoveTracksFromPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public RemoveTracksFromPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

An RemoveTracksFromPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

tracks

public RemoveTracksFromPlaylistRequest.Builder tracks(com.google.gson.JsonArray tracks)

The track URIs setter.

There are several ways to specify which tracks to remove, determined by the request parameters. Removing all occurrences of specific tracks:
[{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" }, {"uri": "spotify:track:1301WleyT98MSxVHPZCA6M" }]
Removing a specific occurrence of a track:
[{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "positions": [0,3] }, { "uri": "spotify:track:1301WleyT98MSxVHPZCA6M", "positions": [7] }]

Parameters:

tracks - Required. An array of objects containing Spotify URIs of the tracks to remove. A maximum of 100 objects can be sent at once

Returns:

A RemoveTracksFromPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

snapshotId

public RemoveTracksFromPlaylistRequest.Builder snapshotId(String snapshotId)

The playlist snapshot ID setter.

To guard against errors when concurrent edits happen to the same playlist, we recommend specifying a snapshot ID. The snapshot ID lets us know which version of the playlist you are trying to edit. Concurrent edits by another user will be automatically resolved. If a given track in a given position is not found in the specified snapshot, the entire request will fail an no edits will take place.

Parameters:

snapshotId - Optional. The playlist's snapshot ID against which you want to make the changes. The API will validate that the specified tracks exist and in the specified positions and make the changes, even if more recent changes have been made to the playlist.

Returns:

A RemoveTracksFromPlaylistRequest.Builder.

See Also:

Spotify: Version Control and Snapshots

build

public RemoveTracksFromPlaylistRequest build()

The request build method.

Returns:

A custom RemoveTracksFromPlaylistRequest.

self

protected RemoveTracksFromPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<SnapshotResult,RemoveTracksFromPlaylistRequest.Builder>

Returns:

This instance.