Package se.michaelthelin.spotify.requests.data.player

Class GetTheUsersQueueRequest

java.lang.Object

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

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

se.michaelthelin.spotify.requests.data.player.GetTheUsersQueueRequest

All Implemented Interfaces:

IRequest<PlaybackQueue>

public class GetTheUsersQueueRequest
extends AbstractDataRequest<PlaybackQueue>

Get the list of objects that make up the user's queue.

Returns the tracks from the current user’s playback queue. Does not include the current playing track.

The endpoint does not support paging since the queue is not expected to be large. Therefore, the request will return a PlaybackQueue object including a List of Track.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
PlaybackQueue	execute()	Get an user's current playback queue.

Methods inherited from class se.michaelthelin.spotify.requests.AbstractRequest

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

Methods inherited from class java.lang.Object

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

Method Detail

execute

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

Get an user's current playback queue.

Returns:

An PlaybackQueue object including a List of Track.

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 - In case of an error parsing the response.