com.wrapper.spotify.requests.data.playlists

Class ReorderPlaylistsTracksRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<SnapshotResult,ReorderPlaylistsTracksRequest.Builder>

Enclosing class:

ReorderPlaylistsTracksRequest

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

Builder class for building a ReorderPlaylistsTracksRequest.

Constructor Summary

Constructors

Constructor and Description
Builder(String accessToken) Create a new ReorderPlaylistsTracksRequest.Builder.

Method Summary

Modifier and Type	Method and Description
ReorderPlaylistsTracksRequest	build() The request build method.
ReorderPlaylistsTracksRequest.Builder	insert_before(Integer insert_before) The insert before setter.
ReorderPlaylistsTracksRequest.Builder	playlist_id(String playlist_id) The playlist ID setter.
ReorderPlaylistsTracksRequest.Builder	range_length(Integer range_length) The range length setter.
ReorderPlaylistsTracksRequest.Builder	range_start(Integer range_start) The range start setter.
protected ReorderPlaylistsTracksRequest.Builder	self() Return this instance to simulate a self-type.
ReorderPlaylistsTracksRequest.Builder	snapshot_id(String snapshot_id) The playlist snapshot ID setter.
ReorderPlaylistsTracksRequest.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/)

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 Detail

Builder

public Builder(String accessToken)

Create a new ReorderPlaylistsTracksRequest.Builder.

Reordering tracks in the current user's public playlists requires authorization of the playlist-modify-public scope; reordering tracks in the current 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 Detail

user_id

@Deprecated
public ReorderPlaylistsTracksRequest.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:

A ReorderPlaylistsTracksRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public ReorderPlaylistsTracksRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A ReorderPlaylistsTracksRequest.Builder.

See Also:

Spotify: URIs & IDs

range_start

public ReorderPlaylistsTracksRequest.Builder range_start(Integer range_start)

The range start setter.

Parameters:

range_start - Required. The position of the first track to be reordered.

Returns:

A ReorderPlaylistsTracksRequest.Builder.

range_length

public ReorderPlaylistsTracksRequest.Builder range_length(Integer range_length)

The range length setter.

Parameters:

range_length - Optional. The amount of tracks to be reordered. Defaults to 1 if not set.

Returns:

A ReorderPlaylistsTracksRequest.Builder.

insert_before

public ReorderPlaylistsTracksRequest.Builder insert_before(Integer insert_before)

The insert before setter.

Parameters:

insert_before - Required. The position where the tracks should be inserted. To reorder the tracks to the end of the playlist, simply set insert_before to the position after the last track.

Returns:

A ReorderPlaylistsTracksRequest.Builder.

snapshot_id

public ReorderPlaylistsTracksRequest.Builder snapshot_id(String snapshot_id)

The playlist snapshot ID setter.

Parameters:

snapshot_id - Optional. The playlist's snapshot ID against which you want to make the changes.

Returns:

A RemoveTracksFromPlaylistRequest.Builder.

See Also:

Spotify: Version Control and Snapshots

build

public ReorderPlaylistsTracksRequest build()

The request build method.

Returns:

A custom ReorderPlaylistsTracksRequest.

self

protected ReorderPlaylistsTracksRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.