Package com.wrapper.spotify.requests.data.browse

Class GetCategorysPlaylistsRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<Paging<T>,BT>

com.wrapper.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistSimplified,GetCategorysPlaylistsRequest.Builder>

com.wrapper.spotify.requests.data.browse.GetCategorysPlaylistsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetCategorysPlaylistsRequest

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

Builder class for building a GetCategorysPlaylistsRequest.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.wrapper.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 com.wrapper.spotify.requests.IRequest.Builder

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetCategorysPlaylistsRequest.Builder instance.

Parameters:

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

Method Details

category_id

public GetCategorysPlaylistsRequest.Builder category_id(String category_id)

The categroy ID setter.

Parameters:

category_id - The Spotify category ID for the category.

Returns:

A GetCategorysPlaylistsRequest.Builder.

See Also:

Spotify URIs & IDs

country

public GetCategorysPlaylistsRequest.Builder country(com.neovisionaries.i18n.CountryCode country)

The country code setter.

Parameters:

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

Returns:

A GetCategorysPlaylistsRequest.Builder.

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes

limit

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

offset

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

build

public GetCategorysPlaylistsRequest build()

The request build method.

Returns:

A custom GetCategorysPlaylistsRequest.

self

protected GetCategorysPlaylistsRequest.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>,GetCategorysPlaylistsRequest.Builder>

Returns:

This instance.