Class ChangePlaylistDetailsRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.playlists.ChangePlaylistDetailsRequest
-
public class ChangePlaylistDetailsRequest extends Object
Change a Playlist's Details requestRequired OAuth scopes
playlist-modify-public, playlist-modify-privateResponse
On success the HTTP status code in the response header is
200OK.On error, the header status code is an error code and the response body contains an error object. Trying to change a playlist when you do not have the user's authorization returns error
403Forbidden.
-
-
Constructor Summary
Constructors Constructor Description ChangePlaylistDetailsRequest(ApiClient apiClient, String playlistId)Change a Playlist's Details request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChangePlaylistDetailsRequest_public(boolean _public)Iftruethe playlist will be public, iffalseit will be private.ApiCall<Void>build()Build the request into an executable callChangePlaylistDetailsRequestcollaborative(boolean collaborative)Iftrue, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client.ChangePlaylistDetailsRequestdescription(String description)Value for playlist description as displayed in Spotify Clients and in the Web API.ChangePlaylistDetailsRequestname(String name)The new name for the playlist, for example"My New Playlist Title"
-
-
-
Constructor Detail
-
ChangePlaylistDetailsRequest
public ChangePlaylistDetailsRequest(ApiClient apiClient, String playlistId)
Change a Playlist's Details request
- Parameters:
apiClient-The API client
playlistId-The Spotify ID for the playlist.
-
-
Method Detail
-
name
public ChangePlaylistDetailsRequest name(String name)
The new name for the playlist, for example
"My New Playlist Title"
-
_public
public ChangePlaylistDetailsRequest _public(boolean _public)
If
truethe playlist will be public, iffalseit will be private.
-
collaborative
public ChangePlaylistDetailsRequest collaborative(boolean collaborative)
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 setcollaborativetotrueon non-public playlists.
-
description
public ChangePlaylistDetailsRequest description(String description)
Value for playlist description as displayed in Spotify Clients and in the Web API.
-
-