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

Class AddTracksToPlaylistRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<SnapshotResult,AddTracksToPlaylistRequest.Builder>

Enclosing class:

AddTracksToPlaylistRequest

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

Builder class for building an AddTracksToPlaylistRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddTracksToPlaylistRequest	build()	The request build method.
AddTracksToPlaylistRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
AddTracksToPlaylistRequest.Builder	position(Integer position)	The position setter.
AddTracksToPlaylistRequest.Builder	position(Integer position, Boolean use_body)	The position setter.
protected AddTracksToPlaylistRequest.Builder	self()	Return this instance to simulate a self-type.
AddTracksToPlaylistRequest.Builder	uris(com.google.gson.JsonArray uris)	The track URIs setter.
AddTracksToPlaylistRequest.Builder	uris(String uris)	The track URIs setter.
AddTracksToPlaylistRequest.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 AddTracksToPlaylistRequest.Builder.

Adding tracks to the current user's public playlists requires authorization of the playlist-modify-public scope; adding tracks to 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

user_id

@Deprecated public AddTracksToPlaylistRequest.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 AddTracksToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public AddTracksToPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

An AddTracksToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

uris

public AddTracksToPlaylistRequest.Builder uris(String uris)

The track URIs setter.

Note: It is likely that passing a large number of track URIs as a query parameter will exceed the maximum length of the request URI. When adding a large number of tracks it is recommended to pass them with uris(JsonArray).

Parameters:

uris - Optional. A comma-separated list of Spotify track URIs to add. Maximum: 100 track URIs.

Returns:

An AddTracksToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

position

public AddTracksToPlaylistRequest.Builder position(Integer position)

The position setter.

Parameters:

position - Optional. The position to insert the tracks, a zero-based index. If omitted, the tracks will be appended to the playlist. Tracks are added in the order they are listed in the query string or request body.

Returns:

An AddTracksToPlaylistRequest.Builder.

uris

public AddTracksToPlaylistRequest.Builder uris(com.google.gson.JsonArray uris)

The track URIs setter.

Note: If the URIs already have been set with uris(String), any URIs listed here will be ignored.

Parameters:

uris - Optional. A JSON array of the Spotify track URIs to add. maximum: 100 track URIs.

Returns:

An AddTracksToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

position

public AddTracksToPlaylistRequest.Builder position(Integer position, Boolean use_body)

The position setter. You can set it in the request query string or request body, depending on the use_body parameter.

Parameters:

position - Optional. The position to insert the tracks, a zero-based index. If omitted, the tracks will be appended to the playlist. Tracks are added in the order they are listed in the query string or request body.

use_body - Whether to include the position in the request query string or body.

Returns:

An AddTracksToPlaylistRequest.Builder.

build

public AddTracksToPlaylistRequest build()

The request build method.

Returns:

A custom AddTracksToPlaylistRequest.

self

protected AddTracksToPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.