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

Class GetUsersTopArtistsAndTracksRequest.Builder<T extends IArtistTrackModelObject>

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<T>,BT>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<T,GetUsersTopArtistsAndTracksRequest.Builder<T>>

se.michaelthelin.spotify.requests.data.personalization.GetUsersTopArtistsAndTracksRequest.Builder<T>

Type Parameters:

T - The request ModelObjectType: artist or track.

All Implemented Interfaces:

IPagingRequestBuilder<T,GetUsersTopArtistsAndTracksRequest.Builder<T>>, IRequest.Builder<Paging<T>,GetUsersTopArtistsAndTracksRequest.Builder<T>>

Enclosing class:

GetUsersTopArtistsAndTracksRequest<T extends IArtistTrackModelObject>

public static final class GetUsersTopArtistsAndTracksRequest.Builder<T extends IArtistTrackModelObject>
extends AbstractDataPagingRequest.Builder<T,GetUsersTopArtistsAndTracksRequest.Builder<T>>

Builder class for building a GetUsersTopArtistsAndTracksRequest.

This class only exists for theoretical purposes. Please use GetUsersTopArtistsRequest.Builder and GetUsersTopTracksRequest.Builder instead.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetUsersTopArtistsAndTracksRequest<T>	build()	The request build method.
GetUsersTopArtistsAndTracksRequest.Builder<T>	limit(Integer limit)	The limit setter.
GetUsersTopArtistsAndTracksRequest.Builder<T>	offset(Integer offset)	The offset setter.
protected GetUsersTopArtistsAndTracksRequest.Builder<T>	self()	Return this instance to simulate a self-type.
GetUsersTopArtistsAndTracksRequest.Builder<T>	time_range(String time_range)	The time range setter.
GetUsersTopArtistsAndTracksRequest.Builder<T>	type(ModelObjectType type)	The model object type setter.

Methods inherited from class se.michaelthelin.spotify.requests.AbstractRequest.Builder

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.michaelthelin.spotify.requests.IRequest.Builder

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

Constructor Detail

Builder

public Builder(String accessToken)

Create a new GetUsersTopArtistsAndTracksRequest.Builder instance.

Getting details of a user's top artists and 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 Detail

type

public GetUsersTopArtistsAndTracksRequest.Builder<T> type(ModelObjectType type)

The model object type setter.

Parameters:

type - The type of entity to return. Valid values: artists or tracks.

Returns:

A GetUsersTopArtistsAndTracksRequest.Builder.

limit

public GetUsersTopArtistsAndTracksRequest.Builder<T> limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetUsersTopArtistsAndTracksRequest.Builder.

offset

public GetUsersTopArtistsAndTracksRequest.Builder<T> 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 GetUsersTopArtistsAndTracksRequest.Builder.

time_range

public GetUsersTopArtistsAndTracksRequest.Builder<T> 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 GetUsersTopArtistsAndTracksRequest.Builder.

build

public GetUsersTopArtistsAndTracksRequest<T> build()

The request build method.

Returns:

A custom GetUsersTopArtistsAndTracksRequest.

self

protected GetUsersTopArtistsAndTracksRequest.Builder<T> self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<T extends IArtistTrackModelObject>,GetUsersTopArtistsAndTracksRequest.Builder<T extends IArtistTrackModelObject>>

Returns:

This instance.