Class ChangePlaylistDetailsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<String, ChangePlaylistDetailsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<String, ChangePlaylistDetailsRequest.Builder>

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

All Implemented Interfaces:

IRequest.Builder<String, ChangePlaylistDetailsRequest.Builder>

Enclosing class:

ChangePlaylistDetailsRequest

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

Builder class for building a ChangePlaylistDetailsRequest.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class AbstractRequest.Builder

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

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

playlist_id

public ChangePlaylistDetailsRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID for the playlist.

Returns:

A ChangePlaylistDetailsRequest.Builder.

See Also:

• Spotify: URIs & IDs

name

public ChangePlaylistDetailsRequest.Builder name(String name)

The playlist name setter.

Parameters:

name - Optional. The new name for the playlist.

Returns:

A ChangePlaylistDetailsRequest.Builder.

public_

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

collaborative

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

description

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

build

public ChangePlaylistDetailsRequest build()

The request build method.

Returns:

A custom ChangePlaylistDetailsRequest.

self

protected ChangePlaylistDetailsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.