Class GetPlaylistsItemsRequest.Builder
- java.lang.Object
-
- se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>
-
- se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Paging<T>,BT>
-
- se.michaelthelin.spotify.requests.data.AbstractDataPagingRequest.Builder<PlaylistTrack,GetPlaylistsItemsRequest.Builder>
-
- se.michaelthelin.spotify.requests.data.playlists.GetPlaylistsItemsRequest.Builder
-
- All Implemented Interfaces:
IPagingRequestBuilder<PlaylistTrack,GetPlaylistsItemsRequest.Builder>,IRequest.Builder<Paging<PlaylistTrack>,GetPlaylistsItemsRequest.Builder>
- Enclosing class:
- GetPlaylistsItemsRequest
public static final class GetPlaylistsItemsRequest.Builder extends AbstractDataPagingRequest.Builder<PlaylistTrack,GetPlaylistsItemsRequest.Builder>
Builder class for building aGetPlaylistsItemsRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder(String accessToken)Create a newGetPlaylistsItemsRequest.Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetPlaylistsItemsRequest.BuilderadditionalTypes(String additionalTypes)The additional types setter.GetPlaylistsItemsRequestbuild()The request build method.GetPlaylistsItemsRequest.Builderfields(String fields)The fields filter setter.GetPlaylistsItemsRequest.Builderlimit(Integer limit)The limit setter.GetPlaylistsItemsRequest.Buildermarket(com.neovisionaries.i18n.CountryCode market)The market country code setter.GetPlaylistsItemsRequest.Builderoffset(Integer offset)The offset setter.GetPlaylistsItemsRequest.Builderplaylist_id(String playlist_id)The playlist ID setter.protected GetPlaylistsItemsRequest.Builderself()Return this instance to simulate a self-type.-
Methods inherited from class se.michaelthelin.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 se.michaelthelin.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 newGetPlaylistsItemsRequest.Builder.Both Public and Private playlists belonging to any user are retrievable on provision of a valid access token.
- Parameters:
accessToken- Required. A valid access token from the Spotify Accounts service.
-
-
Method Detail
-
playlist_id
public GetPlaylistsItemsRequest.Builder playlist_id(String playlist_id)
The playlist ID setter.- Parameters:
playlist_id- The Spotify ID for the playlist.- Returns:
- A
GetPlaylistsItemsRequest.Builder. - See Also:
- Spotify: URIs & IDs
-
fields
public GetPlaylistsItemsRequest.Builder fields(String fields)
The fields filter setter.- Parameters:
fields- Optional. Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned.- Returns:
- A
GetPlaylistsItemsRequest.Builder. - See Also:
- Spotify: More Details on Playlist Fields
-
limit
public GetPlaylistsItemsRequest.Builder limit(Integer limit)
The limit setter.- Parameters:
limit- Optional. The maximum number of items to return. Default: 100. Minimum: 1. Maximum: 100.- Returns:
- A
GetPlaylistsItemsRequest.Builder.
-
offset
public GetPlaylistsItemsRequest.Builder offset(Integer offset)
The offset setter.- Parameters:
offset- Optional. The index of the first item to return. Default: 0 (the first object).- Returns:
- A
GetPlaylistsItemsRequest.Builder.
-
market
public GetPlaylistsItemsRequest.Builder market(com.neovisionaries.i18n.CountryCode market)
The market country code setter.- Parameters:
market- Optional. An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.- Returns:
- A
GetPlaylistsItemsRequest.Builder. - See Also:
- Wikipedia: ISO 3166-1 alpha-2 country codes, Spotify: Track Relinking Guide
-
additionalTypes
public GetPlaylistsItemsRequest.Builder additionalTypes(String additionalTypes)
The additional types setter.- Parameters:
additionalTypes- Optional. A comma-separated list of item types that your client supports besides the default track type. Valid types are:trackandepisode. An unsupported type in the response is expected to be represented asnullvalue in theitemfield.- Returns:
- A
GetPlaylistsItemsRequest.Builder.
-
build
public GetPlaylistsItemsRequest build()
The request build method.- Returns:
- A custom
GetPlaylistsItemsRequest.
-
self
protected GetPlaylistsItemsRequest.Builder self()
Description copied from class:AbstractRequest.BuilderReturn this instance to simulate a self-type.- Specified by:
selfin classAbstractRequest.Builder<Paging<PlaylistTrack>,GetPlaylistsItemsRequest.Builder>- Returns:
- This instance.
-
-