Class GetUsersTopTracksRequest
- java.lang.Object
-
- de.sonallux.spotify.api.apis.personalization.GetUsersTopTracksRequest
-
public class GetUsersTopTracksRequest extends Object
Get a User's Top Tracks requestRequired OAuth scopes
user-top-readResponse
On success, the HTTP status code in the response header is
200 OKand the response body contains a paging object of Tracks. On error, the header status code is an error code and the response body contains an error object.
-
-
Constructor Summary
Constructors Constructor Description GetUsersTopTracksRequest(ApiClient apiClient)Get a User's Top Tracks request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiCall<Paging<Track>>build()Build the request into an executable callGetUsersTopTracksRequestlimit(int limit)The number of entities to return.GetUsersTopTracksRequestoffset(int offset)The index of the first entity to return.GetUsersTopTracksRequesttimeRange(String timeRange)Over what time frame the affinities are computed.
-
-
-
Constructor Detail
-
GetUsersTopTracksRequest
public GetUsersTopTracksRequest(ApiClient apiClient)
Get a User's Top Tracks request
- Parameters:
apiClient-The API client
-
-
Method Detail
-
timeRange
public GetUsersTopTracksRequest timeRange(String timeRange)
Over what time frame the affinities are computed. Valid values:
long_term(calculated from several years of data and including all new data as it becomes available),medium_term(approximately last 6 months),short_term(approximately last 4 weeks). Default:medium_term
-
limit
public GetUsersTopTracksRequest limit(int limit)
The number of entities to return. Default: 20. Minimum: 1. Maximum: 50. For example:
limit=2
-
offset
public GetUsersTopTracksRequest offset(int offset)
The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.
-
-