com.wrapper.spotify.requests.data.playlists

Class ChangePlaylistsDetailsRequest.Builder

java.lang.Object

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

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>

Enclosing class:

ChangePlaylistsDetailsRequest

public static final class ChangePlaylistsDetailsRequest.Builder
extends AbstractDataRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>

Builder class for building a ChangePlaylistsDetailsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ChangePlaylistsDetailsRequest	build() The request build method.
ChangePlaylistsDetailsRequest.Builder	collaborative(Boolean collaborative) The collaborative state setter.
ChangePlaylistsDetailsRequest.Builder	description(String description) The playlist description setter.
ChangePlaylistsDetailsRequest.Builder	name(String name) The playlist name setter.
ChangePlaylistsDetailsRequest.Builder	playlist_id(String playlist_id) The playlist ID setter.
ChangePlaylistsDetailsRequest.Builder	public_(Boolean public_) The public status setter.
protected ChangePlaylistsDetailsRequest.Builder	self() Return this instance to simulate a self-type.
ChangePlaylistsDetailsRequest.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 ChangePlaylistsDetailsRequest.Builder.

Modifying an user's public playlists requires authorization of the playlist-modify-public scope; Modifying 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 Detail

user_id

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

See Also:

Spotify: URIs & IDs

playlist_id

public ChangePlaylistsDetailsRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A ChangePlaylistsDetailsRequest.Builder.

See Also:

Spotify: URIs & IDs

name

public ChangePlaylistsDetailsRequest.Builder name(String name)

The playlist name setter.

Parameters:

name - Optional. The new name for the playlist.

Returns:

A ChangePlaylistsDetailsRequest.Builder.

public_

public ChangePlaylistsDetailsRequest.Builder public_(Boolean public_)

The public status setter.

Parameters:

public_ - Optional. If true the playlist will be public, if false it will be private.

Returns:

A ChangePlaylistsDetailsRequest.Builder.

collaborative

public ChangePlaylistsDetailsRequest.Builder collaborative(Boolean collaborative)

The collaborative state setter.

Parameters:

collaborative - Optional. If true, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client. Note: You can only set this to true on non-public playlists.

Returns:

A ChangePlaylistsDetailsRequest.Builder.

description

public ChangePlaylistsDetailsRequest.Builder description(String description)

The playlist description setter.

Parameters:

description - Optional, value for playlist description as displayed in Spotify Clients and in the Web API.

Returns:

A ChangePlaylistsDetailsRequest.Builder.

build

public ChangePlaylistsDetailsRequest build()

The request build method.

Returns:

A custom ChangePlaylistsDetailsRequest.

self

protected ChangePlaylistsDetailsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>

Returns:

This instance.