Class SearchPlaylistsRequest.Builder

java.lang.Object

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

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

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

se.michaelthelin.spotify.requests.data.search.simplified.SearchPlaylistsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SearchPlaylistsRequest

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

Builder class for building a SearchPlaylistsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new SearchPlaylistsRequest.Builder.

Method Summary

Modifier and Type	Method	Description
SearchPlaylistsRequest	build()	The request build method.
SearchPlaylistsRequest.Builder	includeExternal(String includeExternal)	The include external setter.
SearchPlaylistsRequest.Builder	limit(Integer limit)	The limit setter.
SearchPlaylistsRequest.Builder	market(CountryCode market)	The market country code setter.
SearchPlaylistsRequest.Builder	offset(Integer offset)	The offset setter.
SearchPlaylistsRequest.Builder	q(String q)	The search query setter.
protected SearchPlaylistsRequest.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

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

Parameters:

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

Method Details

q

public SearchPlaylistsRequest.Builder q(String q)

The search query setter.

Parameters:

q - Required. The search query's keywords (and optional field filters and operators).

Returns:

A SearchPlaylistsRequest.Builder.

See Also:

• Spotify: Search Query Options

market

public SearchPlaylistsRequest.Builder market(CountryCode market)

The market country code setter.

Parameters:

market - Optional. An ISO 3166-1 alpha-2 country code. If a country code is given, only artists, albums, and tracks with content playable in that market will be returned. (Playlist results are not affected by the market parameter.)

Returns:

A SearchPlaylistsRequest.Builder.

See Also:

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

limit

public SearchPlaylistsRequest.Builder limit(Integer limit)

The limit setter.

Parameters:

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

Returns:

A SearchPlaylistsRequest.Builder.

offset

public SearchPlaylistsRequest.Builder offset(Integer offset)

The offset setter.

Parameters:

offset - Optional. The index of the first result to return. Default: 0 (i.e., the first result). Maximum offset: 100.000. Use with limit(Integer) to get the next page of search results.

Returns:

A SearchPlaylistsRequest.Builder.

includeExternal

public SearchPlaylistsRequest.Builder includeExternal(String includeExternal)

The include external setter.

Parameters:

includeExternal - Optional. Possible values: audio. If audio is set the response will include any relevant audio content that is hosted externally. By default external content is filtered out from responses.

Returns:

A SearchPlaylistsRequest.Builder.

build

public SearchPlaylistsRequest build()

The request build method.

Returns:

A SearchPlaylistsRequest.Builder.

self

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

Returns:

This instance.