Class GetUsersTopTracksRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<Track>, GetUsersTopTracksRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<Track>, GetUsersTopTracksRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<Track, GetUsersTopTracksRequest.Builder>

se.michaelthelin.spotify.requests.data.users.simplified.GetUsersTopTracksRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<Track, GetUsersTopTracksRequest.Builder>, IRequest.Builder<Paging<Track>, GetUsersTopTracksRequest.Builder>

Enclosing class:

GetUsersTopTracksRequest

public static final class GetUsersTopTracksRequest.Builder
extends AbstractDataPagingRequest.Builder<Track, GetUsersTopTracksRequest.Builder>

Builder class for building a GetUsersTopTracksRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new GetUsersTopTracksRequest.Builder instance.

Method Summary

Modifier and Type	Method	Description
GetUsersTopTracksRequest	build()	The request build method.
GetUsersTopTracksRequest.Builder	limit(Integer limit)	The limit setter.
GetUsersTopTracksRequest.Builder	offset(Integer offset)	The offset setter.
protected GetUsersTopTracksRequest.Builder	self()	Return this instance to simulate a self-type.
GetUsersTopTracksRequest.Builder	time_range(String time_range)	The time range setter.

Methods inherited from class AbstractRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Methods inherited from class Object

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

Methods inherited from interface IRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetUsersTopTracksRequest.Builder instance.

Getting details of a user's top tracks requires authorization of the user-top-read scope.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

See Also:

• Spotify: Using Scopes

Method Details

limit

public GetUsersTopTracksRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

limit - Optional. The number of entities to return. Default: 20. Minimum: 1. Maximum: 50.

Returns:

A GetUsersTopTracksRequest.Builder.

offset

public GetUsersTopTracksRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit(Integer) to get the next set of entities.

Returns:

A GetUsersTopTracksRequest.Builder.

time_range

public GetUsersTopTracksRequest.Builder time_range(String time_range)

The time range setter.

Parameters:

time_range - Optional. 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.

Returns:

A GetUsersTopTracksRequest.Builder.

build

public GetUsersTopTracksRequest build()

The request build method.

Returns:

A custom GetUsersTopTracksRequest

self

protected GetUsersTopTracksRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<Track>, GetUsersTopTracksRequest.Builder>

Returns:

This instance.