Package se.michaelthelin.spotify.requests.data.personalization.simplified

Class GetUsersTopArtistsRequest

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest<Paging<Artist>>

se.michaelthelin.spotify.requests.data.AbstractDataRequest<Paging<Artist>>

se.michaelthelin.spotify.requests.data.personalization.simplified.GetUsersTopArtistsRequest

All Implemented Interfaces:

IRequest<Paging<Artist>>

public class GetUsersTopArtistsRequest
extends AbstractDataRequest<Paging<Artist>>

Get the current user’s top artists based on calculated affinity.

Affinity is a measure of the expected preference a user has for a particular track or artist. It is based on user behavior, including play history, but does not include actions made while in incognito mode. Light or infrequent users of Spotify may not have sufficient play history to generate a full affinity data set.

As a user’s behavior is likely to shift over time, this preference data is available over three time spans. See GetUsersTopArtistsRequest.Builder.time_range(String) for more information.

For each time range, the top 50 tracks and artists are available for each user. In the future, it is likely that this restriction will be relaxed. This data is typically updated once each day for each user.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Paging<Artist>	execute()	Get an user's top artists.

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 Details

execute

public Paging<Artist> execute()
                       throws IOException,
SpotifyWebApiException,
org.apache.hc.core5.http.ParseException

Get an user's top artists.

Returns:

An user's top artists.

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.