Class AddItemsToPlaylistRequest.Builder
- java.lang.Object
-
- se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>
-
- se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<SnapshotResult,AddItemsToPlaylistRequest.Builder>
-
- se.michaelthelin.spotify.requests.data.playlists.AddItemsToPlaylistRequest.Builder
-
- All Implemented Interfaces:
IRequest.Builder<SnapshotResult,AddItemsToPlaylistRequest.Builder>
- Enclosing class:
- AddItemsToPlaylistRequest
public static final class AddItemsToPlaylistRequest.Builder extends AbstractDataRequest.Builder<SnapshotResult,AddItemsToPlaylistRequest.Builder>
Builder class for building anAddItemsToPlaylistRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder(String accessToken)Create a newAddItemsToPlaylistRequest.Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddItemsToPlaylistRequestbuild()The request build method.AddItemsToPlaylistRequest.Builderplaylist_id(String playlist_id)The playlist ID setter.AddItemsToPlaylistRequest.Builderposition(Integer position)The position setter.AddItemsToPlaylistRequest.Builderposition(Integer position, Boolean use_body)The position setter.protected AddItemsToPlaylistRequest.Builderself()Return this instance to simulate a self-type.AddItemsToPlaylistRequest.Builderuris(com.google.gson.JsonArray uris)The item URIs setter.AddItemsToPlaylistRequest.Builderuris(String uris)The item URIs setter.-
Methods inherited from class se.michaelthelin.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 newAddItemsToPlaylistRequest.Builder.Adding items to the current user's public playlists requires authorization of the
playlist-modify-publicscope; adding items to the current user's private playlist (including collaborative playlists) requires theplaylist-modify-privatescope.- Parameters:
accessToken- Required. A valid access token from the Spotify Accounts service.- See Also:
- Spotify: Using Scopes
-
-
Method Detail
-
playlist_id
public AddItemsToPlaylistRequest.Builder playlist_id(String playlist_id)
The playlist ID setter.- Parameters:
playlist_id- The Spotify ID for the playlist.- Returns:
- An
AddItemsToPlaylistRequest.Builder. - See Also:
- Spotify: URIs & IDs
-
uris
public AddItemsToPlaylistRequest.Builder uris(String uris)
The item URIs setter.Note: It is likely that passing a large number of item URIs as a query parameter will exceed the maximum length of the request URI. When adding a large number of items it is recommended to pass them with
uris(JsonArray).- Parameters:
uris- Optional. A comma-separated list of Spotify track or episode URIs to add. Maximum: 100 item URIs.- Returns:
- An
AddItemsToPlaylistRequest.Builder. - See Also:
- Spotify: URIs & IDs
-
position
public AddItemsToPlaylistRequest.Builder position(Integer position)
The position setter.- Parameters:
position- Optional. The position to insert the items, a zero-based index. If omitted, the items will be appended to the playlist. Items are added in the order they are listed in the query string or request body.- Returns:
- An
AddItemsToPlaylistRequest.Builder.
-
uris
public AddItemsToPlaylistRequest.Builder uris(com.google.gson.JsonArray uris)
The item URIs setter.Note: If the URIs already have been set with
uris(String), any URIs listed here will be ignored.- Parameters:
uris- Optional. A JSON array of the Spotify track or episode URIs to add. maximum: 100 item URIs.- Returns:
- An
AddItemsToPlaylistRequest.Builder. - See Also:
- Spotify: URIs & IDs
-
position
public AddItemsToPlaylistRequest.Builder position(Integer position, Boolean use_body)
The position setter. You can set it in the request query string or request body, depending on theuse_bodyparameter.- Parameters:
position- Optional. The position to insert the items, a zero-based index. If omitted, the items will be appended to the playlist. Items are added in the order they are listed in the query string or request body.use_body- Whether to include the position in the request query string or body.- Returns:
- An
AddItemsToPlaylistRequest.Builder.
-
build
public AddItemsToPlaylistRequest build()
The request build method.- Returns:
- A custom
AddItemsToPlaylistRequest.
-
self
protected AddItemsToPlaylistRequest.Builder self()
Description copied from class:AbstractRequest.BuilderReturn this instance to simulate a self-type.- Specified by:
selfin classAbstractRequest.Builder<SnapshotResult,AddItemsToPlaylistRequest.Builder>- Returns:
- This instance.
-
-