Class SearchForItemRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<SearchResult, SearchForItemRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<SearchResult, SearchForItemRequest.Builder>

se.michaelthelin.spotify.requests.data.search.SearchForItemRequest.Builder

All Implemented Interfaces:

IRequest.Builder<SearchResult, SearchForItemRequest.Builder>

Enclosing class:

SearchForItemRequest

public static final class SearchForItemRequest.Builder
extends AbstractDataRequest.Builder<SearchResult, SearchForItemRequest.Builder>

Builder class for building a SearchForItemRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SearchForItemRequest	build()	The request build method.
SearchForItemRequest.Builder	includeExternal(String includeExternal)	The include external setter.
SearchForItemRequest.Builder	limit(Integer limit)	The limit setter.
SearchForItemRequest.Builder	market(CountryCode market)	The market country code setter.
SearchForItemRequest.Builder	offset(Integer offset)	The offset setter.
SearchForItemRequest.Builder	q(String q)	The search query setter.
protected SearchForItemRequest.Builder	self()	Return this instance to simulate a self-type.
SearchForItemRequest.Builder	type(String type)	The type setter.

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new SearchForItemRequest.Builder.

Parameters:

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

Method Details

q

public SearchForItemRequest.Builder q(String q)

The search query setter.

Parameters:

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

Returns:

A SearchForItemRequest.Builder.

See Also:

• Spotify: Search Query Options

type

public SearchForItemRequest.Builder type(String type)

The type setter.

Parameters:

type - Required. A comma-separated list of item types to search across. Valid types are: album, artist, audiobook, episode, playlist, show and track.

Returns:

A SearchForItemRequest.Builder.

market

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

See Also:

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

limit

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

offset

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

includeExternal

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

build

public SearchForItemRequest build()

The request build method.

Returns:

A SearchForItemRequest.Builder.

self

protected SearchForItemRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<SearchResult, SearchForItemRequest.Builder>

Returns:

This instance.