Class ChangePlaylistsDetailsRequest.Builder
java.lang.Object
se.michaelthelin.spotify.requests.AbstractRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>
se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<String,ChangePlaylistsDetailsRequest.Builder>
se.michaelthelin.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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
The request build method.collaborative
(Boolean collaborative) The collaborative state setter.description
(String description) The playlist description setter.The playlist name setter.playlist_id
(String playlist_id) The playlist ID setter.The public status setter.protected ChangePlaylistsDetailsRequest.Builder
self()
Return this instance to simulate a self-type.Methods inherited from class se.michaelthelin.spotify.requests.AbstractRequest.Builder
setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme
-
Constructor Details
-
Builder
Create a newChangePlaylistsDetailsRequest.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 theplaylist-modify-private
scope.- Parameters:
accessToken
- Required. A valid access token from the Spotify Accounts service.- See Also:
-
-
Method Details
-
playlist_id
The playlist ID setter.- Parameters:
playlist_id
- The Spotify ID for the playlist.- Returns:
- A
ChangePlaylistsDetailsRequest.Builder
. - See Also:
-
name
The playlist name setter.- Parameters:
name
- Optional. The new name for the playlist.- Returns:
- A
ChangePlaylistsDetailsRequest.Builder
.
-
public_
The public status setter.- Parameters:
public_
- Optional. Iftrue
the playlist will be public, iffalse
it will be private.- Returns:
- A
ChangePlaylistsDetailsRequest.Builder
.
-
collaborative
The collaborative state setter.- Parameters:
collaborative
- Optional. Iftrue
, 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 totrue
on non-public playlists.- Returns:
- A
ChangePlaylistsDetailsRequest.Builder
.
-
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
The request build method.- Returns:
- A custom
ChangePlaylistsDetailsRequest
.
-
self
Description copied from class:AbstractRequest.Builder
Return this instance to simulate a self-type.- Specified by:
self
in classAbstractRequest.Builder<String,
ChangePlaylistsDetailsRequest.Builder> - Returns:
- This instance.
-