com.wrapper.spotify.requests.data.browse

Class GetCategoriesPlaylistsRequest.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,GetCategoriesPlaylistsRequest.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

GetCategoriesPlaylistsRequest

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

Builder class for building a GetCategoriesPlaylistsRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GetCategoriesPlaylistsRequest	build() The request build method.
GetCategoriesPlaylistsRequest.Builder	category_id(String category_id) The categroy ID setter.
GetCategoriesPlaylistsRequest.Builder	country(com.neovisionaries.i18n.CountryCode country) The country code setter.
GetCategoriesPlaylistsRequest.Builder	limit(Integer limit) The limit setter.
GetCategoriesPlaylistsRequest.Builder	offset(Integer offset) The offset setter.
protected GetCategoriesPlaylistsRequest.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 Detail

Builder

public Builder(String accessToken)

Create a new GetCategoriesPlaylistsRequest.Builder instance.

Parameters:

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

Method Detail

category_id

public GetCategoriesPlaylistsRequest.Builder category_id(String category_id)

The categroy ID setter.

Parameters:

category_id - The Spotify category ID for the category.

Returns:

A GetCategoriesPlaylistsRequest.Builder.

See Also:

Spotify URIs & IDs

country

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

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes

limit

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

offset

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

build

public GetCategoriesPlaylistsRequest build()

The request build method.

Returns:

A custom GetCategoriesPlaylistsRequest.

self

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

Returns:

This instance.