Class GetCategoryPlaylistsRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Paging<PlaylistSimplified>, GetCategoryPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<PlaylistSimplified>, GetCategoryPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistSimplified, GetCategoryPlaylistsRequest.Builder>

se.michaelthelin.spotify.requests.data.playlists.GetCategoryPlaylistsRequest.Builder

All Implemented Interfaces:

IPagingRequestBuilder<PlaylistSimplified, GetCategoryPlaylistsRequest.Builder>, IRequest.Builder<Paging<PlaylistSimplified>, GetCategoryPlaylistsRequest.Builder>

Enclosing class:

GetCategoryPlaylistsRequest

public static final class GetCategoryPlaylistsRequest.Builder
extends AbstractDataPagingRequest.Builder<PlaylistSimplified, GetCategoryPlaylistsRequest.Builder>

Builder class for building a GetCategoryPlaylistsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetCategoryPlaylistsRequest	build()	The request build method.
GetCategoryPlaylistsRequest.Builder	category_id(String category_id)	The categroy ID setter.
GetCategoryPlaylistsRequest.Builder	country(CountryCode country)	The country code setter.
GetCategoryPlaylistsRequest.Builder	limit(Integer limit)	The limit setter.
GetCategoryPlaylistsRequest.Builder	offset(Integer offset)	The offset setter.
protected GetCategoryPlaylistsRequest.Builder	self()	Return this instance to simulate a self-type.

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 GetCategoryPlaylistsRequest.Builder instance.

Parameters:

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

Method Details

category_id

public GetCategoryPlaylistsRequest.Builder category_id(String category_id)

The categroy ID setter.

Parameters:

category_id - The Spotify category ID for the category.

Returns:

A GetCategoryPlaylistsRequest.Builder.

See Also:

• Spotify URIs & IDs

country

public GetCategoryPlaylistsRequest.Builder country(CountryCode country)

The country code setter.

Parameters:

country - Optional. A country: an ISO 3166-1 alpha-2 country code.

Returns:

A GetCategoryPlaylistsRequest.Builder.

See Also:

• Wikipedia: ISO 3166-1 alpha-2 country codes

limit

public GetCategoryPlaylistsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A GetCategoryPlaylistsRequest.Builder.

offset

public GetCategoryPlaylistsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first item to return. Default: 0 (the first object). Use with limit(Integer) to get the next set of items.

Returns:

A GetCategoryPlaylistsRequest.Builder.

build

public GetCategoryPlaylistsRequest build()

The request build method.

Returns:

A custom GetCategoryPlaylistsRequest.

self

protected GetCategoryPlaylistsRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Paging<PlaylistSimplified>, GetCategoryPlaylistsRequest.Builder>

Returns:

This instance.