Class GetUsersQueueRequest

java.lang.Object

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

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

se.michaelthelin.spotify.requests.data.player.GetUsersQueueRequest

All Implemented Interfaces:

IRequest<PlaybackQueue>

public class GetUsersQueueRequest
extends AbstractDataRequest<PlaybackQueue>

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

Returns the items from the current user’s playback queue, including the currently playing item.

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 IPlaylistItem.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class AbstractRequest

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

Modifier and Type	Method	Description
String	bodyParametersToJson(List<org.apache.hc.core5.http.NameValuePair> bodyParameters)	Convert body parameters to JSON string.
String	deleteJson()	Execute DELETE request and get JSON response.
CompletableFuture<PlaybackQueue>	executeAsync()	Get something asynchronously.
org.apache.hc.core5.http.HttpEntity	getBody()	Get the request body.
List<org.apache.hc.core5.http.NameValuePair>	getBodyParameters()	Get the body parameters for this request.
org.apache.hc.core5.http.ContentType	getContentType()	Get the content type for this request.
List<org.apache.hc.core5.http.Header>	getHeaders()	Get the headers for this request.
IHttpManager	getHttpManager()	Get the HTTP manager for this request.
String	getJson()	Get JSON response as string.
URI	getUri()	Get the URI for this request.
void	initializeBody()	Initialize the request body based on content type.
String	postJson()	Execute POST request and get JSON response.
String	putJson()	Execute PUT request and get JSON response.

Methods inherited from class Object

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

Method Details

execute

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

Get the user's current playback queue.

Returns:

An PlaybackQueue object including a List of IPlaylistItem.

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.