com.wrapper.spotify.requests.data.playlists

Class AddItemsToPlaylistRequest.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

IRequest.Builder<SnapshotResult,AddItemsToPlaylistRequest.Builder>

Enclosing class:

AddItemsToPlaylistRequest

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

Builder class for building an AddItemsToPlaylistRequest.

Constructor Summary

Constructors

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

Method Summary

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

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

user_id

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

See Also:

Spotify: URIs & IDs

playlist_id

public AddItemsToPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

An AddItemsToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

uris

public AddItemsToPlaylistRequest.Builder uris(String uris)

The item URIs setter.

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

Parameters:

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

Returns:

An AddItemsToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

position

public AddItemsToPlaylistRequest.Builder position(Integer position)

The position setter.

Parameters:

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

Returns:

An AddItemsToPlaylistRequest.Builder.

uris

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

The item 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 or episode URIs to add. maximum: 100 item URIs.

Returns:

An AddItemsToPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

position

public AddItemsToPlaylistRequest.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 items, a zero-based index. If omitted, the items will be appended to the playlist. Items 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 AddItemsToPlaylistRequest.Builder.

build

public AddItemsToPlaylistRequest build()

The request build method.

Returns:

A custom AddItemsToPlaylistRequest.

self

protected AddItemsToPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.