Package com.wrapper.spotify.requests.data.personalization.simplified

Class GetUsersTopArtistsRequest

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest

com.wrapper.spotify.requests.data.AbstractDataRequest

com.wrapper.spotify.requests.data.personalization.simplified.GetUsersTopArtistsRequest

All Implemented Interfaces:

IRequest

public class GetUsersTopArtistsRequest
extends AbstractDataRequest

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 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 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<Artist> execute()
                       throws IOException,
                              SpotifyWebApiException

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.