com.wrapper.spotify.requests.data.search.simplified.special

Class SearchAlbumsSpecialRequest

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest<T>

com.wrapper.spotify.requests.data.AbstractDataRequest<Paging<AlbumSimplifiedSpecial>>

com.wrapper.spotify.requests.data.search.simplified.special.SearchAlbumsSpecialRequest

All Implemented Interfaces:

IRequest<Paging<AlbumSimplifiedSpecial>>

public class SearchAlbumsSpecialRequest
extends AbstractDataRequest<Paging<AlbumSimplifiedSpecial>>

Get Spotify catalog information about albums that match a keyword string.

This class exists because it includes the property totalTracks, which is not documented in the official specification, although the albums object as returned by the searches API includes it.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Paging<AlbumSimplifiedSpecial>	execute() Search for albums.

Methods inherited from class com.wrapper.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 Paging<AlbumSimplifiedSpecial> execute()
                                       throws IOException,
                                              SpotifyWebApiException,
                                              org.apache.hc.core5.http.ParseException

Search for albums.

Returns:

An AlbumSimplifiedSpecial paging.

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