Class UpdatePlaylistsItemsReplaceRequest

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest<SnapshotResult>

se.michaelthelin.spotify.requests.data.AbstractDataRequest<SnapshotResult>

se.michaelthelin.spotify.requests.data.playlists.UpdatePlaylistsItemsReplaceRequest

All Implemented Interfaces:

IRequest<SnapshotResult>

public class UpdatePlaylistsItemsReplaceRequest
extends AbstractDataRequest<SnapshotResult>

Replace all the items in a playlist, overwriting its existing items. This powerful request can be useful for replacing items, re-ordering existing items, or clearing the playlist.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UpdatePlaylistsItemsReplaceRequest.Builder	Builder class for building a UpdatePlaylistsItemsReplaceRequest.

Method Summary

Modifier and Type	Method	Description
SnapshotResult	execute()	Replace items in a playlist.

Methods inherited from class AbstractRequest

bodyParametersToJson, deleteJson, executeAsync, getBody, getBodyParameters, getContentType, getHeaders, getHttpManager, getJson, getUri, initializeBody, postJson, putJson

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

execute

public SnapshotResult execute()
                       throws IOException,
SpotifyWebApiException,
org.apache.hc.core5.http.ParseException

Replace items in a playlist.

Returns:

A playlist snapshot ID. The snapshot ID can be used to identify your playlist version in future requests.

Throws:

IOException - In case of networking issues.

SpotifyWebApiException - The Web API returned an error further specified in this exception's root cause.

org.apache.hc.core5.http.ParseException - If a parsing error occurs.

See Also:

• Spotify: Version Control and Snapshots