Class GetUsersTopArtistsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<Artist>, GetUsersTopArtistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<Artist>, GetUsersTopArtistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<Artist, GetUsersTopArtistsRequest.Builder>

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

All Implemented Interfaces:

IPagingRequestBuilder<Artist, GetUsersTopArtistsRequest.Builder>, IRequest.Builder<Paging<Artist>, GetUsersTopArtistsRequest.Builder>

Enclosing class:

GetUsersTopArtistsRequest

public static final class GetUsersTopArtistsRequest.Builder
extends AbstractDataPagingRequest.Builder<Artist, GetUsersTopArtistsRequest.Builder>

Builder class for building a GetUsersTopArtistsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetUsersTopArtistsRequest	build()	The request build method.
GetUsersTopArtistsRequest.Builder	limit(Integer limit)	The limit setter.
GetUsersTopArtistsRequest.Builder	offset(Integer offset)	The offset setter.
protected GetUsersTopArtistsRequest.Builder	self()	Return this instance to simulate a self-type.
GetUsersTopArtistsRequest.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

Modifier and Type	Method	Description
GetUsersTopArtistsRequest.Builder	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> GetUsersTopArtistsRequest.Builder	setBodyParameter(String name, X value)	Set a body parameter for the request.
GetUsersTopArtistsRequest.Builder	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
GetUsersTopArtistsRequest.Builder	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> GetUsersTopArtistsRequest.Builder	setHeader(String name, X value)	Set a header for the request.
GetUsersTopArtistsRequest.Builder	setHost(String host)	Set the host for the request.
GetUsersTopArtistsRequest.Builder	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
GetUsersTopArtistsRequest.Builder	setPath(String path)	Set the path for the request.
GetUsersTopArtistsRequest.Builder	setPathParameter(String name, String value)	Set a path parameter for the request.
GetUsersTopArtistsRequest.Builder	setPort(Integer port)	Set the port for the request.
<X> GetUsersTopArtistsRequest.Builder	setQueryParameter(String name, X value)	Set a query parameter for the request.
GetUsersTopArtistsRequest.Builder	setScheme(String scheme)	Set the scheme for the request.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetUsersTopArtistsRequest.Builder instance.

Getting details of a user's top artists 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 GetUsersTopArtistsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetUsersTopArtistsRequest.Builder.

offset

public GetUsersTopArtistsRequest.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 GetUsersTopArtistsRequest.Builder.

time_range

public GetUsersTopArtistsRequest.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 GetUsersTopArtistsRequest.Builder.

build

public GetUsersTopArtistsRequest build()

The request build method.

Returns:

A custom GetUsersTopArtistsRequest.

self

protected GetUsersTopArtistsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<Artist>, GetUsersTopArtistsRequest.Builder>

Returns:

This instance.