Class UpdatePlaylistsItemsReorderRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<SnapshotResult, UpdatePlaylistsItemsReorderRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<SnapshotResult, UpdatePlaylistsItemsReorderRequest.Builder>

se.michaelthelin.spotify.requests.data.playlists.UpdatePlaylistsItemsReorderRequest.Builder

All Implemented Interfaces:

IRequest.Builder<SnapshotResult, UpdatePlaylistsItemsReorderRequest.Builder>

Enclosing class:

UpdatePlaylistsItemsReorderRequest

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

Builder class for building a UpdatePlaylistsItemsReorderRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
UpdatePlaylistsItemsReorderRequest	build()	The request build method.
UpdatePlaylistsItemsReorderRequest.Builder	insert_before(Integer insert_before)	The insert before setter.
UpdatePlaylistsItemsReorderRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
UpdatePlaylistsItemsReorderRequest.Builder	range_length(Integer range_length)	The range length setter.
UpdatePlaylistsItemsReorderRequest.Builder	range_start(Integer range_start)	The range start setter.
protected UpdatePlaylistsItemsReorderRequest.Builder	self()	Return this instance to simulate a self-type.
UpdatePlaylistsItemsReorderRequest.Builder	snapshot_id(String snapshot_id)	The playlist snapshot ID setter.

Methods inherited from class AbstractRequest.Builder

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

Modifier and Type	Method	Description
UpdatePlaylistsItemsReorderRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> UpdatePlaylistsItemsReorderRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> UpdatePlaylistsItemsReorderRequest.Builder	setHeader(String name, X value)	Set a header for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setHost(String host)	Set the host for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setPath(String path)	Set the path for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> UpdatePlaylistsItemsReorderRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
UpdatePlaylistsItemsReorderRequest.Builder	setScheme(String scheme)	Set the scheme for the request.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new UpdatePlaylistsItemsReorderRequest.Builder.

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

playlist_id

public UpdatePlaylistsItemsReorderRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A UpdatePlaylistsItemsReorderRequest.Builder.

See Also:

• Spotify: URIs & IDs

range_start

public UpdatePlaylistsItemsReorderRequest.Builder range_start(Integer range_start)

The range start setter.

Parameters:

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

Returns:

A UpdatePlaylistsItemsReorderRequest.Builder.

range_length

public UpdatePlaylistsItemsReorderRequest.Builder range_length(Integer range_length)

The range length setter.

Parameters:

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

Returns:

A UpdatePlaylistsItemsReorderRequest.Builder.

insert_before

public UpdatePlaylistsItemsReorderRequest.Builder insert_before(Integer insert_before)

The insert before setter.

Parameters:

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

Returns:

A UpdatePlaylistsItemsReorderRequest.Builder.

snapshot_id

public UpdatePlaylistsItemsReorderRequest.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 UpdatePlaylistsItemsReorderRequest.Builder.

See Also:

• Spotify: Version Control and Snapshots

build

public UpdatePlaylistsItemsReorderRequest build()

The request build method.

Returns:

A custom UpdatePlaylistsItemsReorderRequest.

self

protected UpdatePlaylistsItemsReorderRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.