Class GetListOfFeaturedPlaylistsRequest.Builder
- java.lang.Object
-
- com.wrapper.spotify.requests.AbstractRequest.Builder<BuilderType>
-
- com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<GetListOfFeaturedPlaylistsRequest.Builder>
-
- com.wrapper.spotify.requests.data.browse.GetListOfFeaturedPlaylistsRequest.Builder
-
- All Implemented Interfaces:
IRequest.Builder
- Enclosing class:
- GetListOfFeaturedPlaylistsRequest
public static final class GetListOfFeaturedPlaylistsRequest.Builder extends AbstractDataRequest.Builder<GetListOfFeaturedPlaylistsRequest.Builder>
Builder class for building aGetListOfFeaturedPlaylistsRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder(String accessToken)Create a newGetListOfFeaturedPlaylistsRequest.Builderinstance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetListOfFeaturedPlaylistsRequestbuild()The request build method.GetListOfFeaturedPlaylistsRequest.Buildercountry(com.neovisionaries.i18n.CountryCode country)The country code setter.GetListOfFeaturedPlaylistsRequest.Builderlimit(Integer limit)The limit setter.GetListOfFeaturedPlaylistsRequest.Builderlocale(String locale)The language code setter.GetListOfFeaturedPlaylistsRequest.Builderoffset(Integer offset)The offset setter.GetListOfFeaturedPlaylistsRequest.Buildertimestamp(Date timestamp)The timestamp setter.-
Methods inherited from class com.wrapper.spotify.requests.AbstractRequest.Builder
setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme
-
-
-
-
Constructor Detail
-
Builder
public Builder(String accessToken)
Create a newGetListOfFeaturedPlaylistsRequest.Builderinstance.- Parameters:
accessToken- Required. A valid access token from the Spotify Accounts service.
-
-
Method Detail
-
locale
public GetListOfFeaturedPlaylistsRequest.Builder locale(String locale)
The language code setter.- Parameters:
locale- Optional. The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the category metadata returned in a particular language. Note that, if locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For examplecountry=SE&locale=de_DEwill return a list of categories relevant to Sweden but as German language strings.- Returns:
- A
GetListOfFeaturedPlaylistsRequest.Builder. - See Also:
- Wikipedia: ISO 3166-1 alpha-2 country codes, Wikipedia: ISO 639 language code
-
country
public GetListOfFeaturedPlaylistsRequest.Builder country(com.neovisionaries.i18n.CountryCode country)
The country code setter.- Parameters:
country- Optional. A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country. If omitted, the returned items will be globally relevant.- Returns:
- A
GetListOfFeaturedPlaylistsRequest.Builder. - See Also:
- Wikipedia: ISO 3166-1 alpha-2 country codes
-
timestamp
public GetListOfFeaturedPlaylistsRequest.Builder timestamp(Date timestamp)
The timestamp setter.- Parameters:
timestamp- Optional. A timestamp in ISO 8601 format. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time.- Returns:
- A
GetListOfFeaturedPlaylistsRequest.Builder. - See Also:
- Wikipedia: ISO 8601 timestamps
-
limit
public GetListOfFeaturedPlaylistsRequest.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
GetListOfFeaturedPlaylistsRequest.Builder.
-
offset
public GetListOfFeaturedPlaylistsRequest.Builder offset(Integer offset)
The offset setter.- Parameters:
offset- Optional. The index of the first item to return. Default: 0 (the first object). Use withlimit(Integer)to get the next set of items.- Returns:
- A
GetListOfFeaturedPlaylistsRequest.Builder.
-
build
public GetListOfFeaturedPlaylistsRequest build()
The request build method.- Returns:
- A custom
GetListOfFeaturedPlaylistsRequest.
-
-