Class CheckIfUserFollowsPlaylistRequest.Builder

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<Boolean[], CheckIfUserFollowsPlaylistRequest.Builder>

se.michaelthelin.spotify.requests.data.AbstractDataRequest.Builder<Boolean[], CheckIfUserFollowsPlaylistRequest.Builder>

se.michaelthelin.spotify.requests.data.users.CheckIfUserFollowsPlaylistRequest.Builder

All Implemented Interfaces:

IRequest.Builder<Boolean[], CheckIfUserFollowsPlaylistRequest.Builder>

Enclosing class:

CheckIfUserFollowsPlaylistRequest

public static final class CheckIfUserFollowsPlaylistRequest.Builder
extends AbstractDataRequest.Builder<Boolean[], CheckIfUserFollowsPlaylistRequest.Builder>

Builder class for building a CheckIfUserFollowsPlaylistRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new CheckIfUserFollowsPlaylistRequest.Builder instance.

Method Summary

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

Following a playlist can be done publicly or privately. Checking if a user publicly follows a playlist doesn't require any scopes; if the user is publicly following the playlist, this endpoint returns true.

Checking if the user is privately following a playlist is only possible for the current user when that user has granted access to the playlist-read-private scope.

Parameters:

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

See Also:

• Spotify: Using Scopes

Method Details

playlist_id

public CheckIfUserFollowsPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID of the playlist.

Returns:

A CheckIfUserFollowsPlaylistRequest.Builder.

See Also:

• Spotify: URIs & IDs

ids

public CheckIfUserFollowsPlaylistRequest.Builder ids(String ids)

The user IDs setter.

Parameters:

ids - Optional. A single item list containing the current user's Spotify username. Maximum: 1 id.

Returns:

A CheckIfUserFollowsPlaylistRequest.Builder.

See Also:

• Spotify: URIs & IDs

build

public CheckIfUserFollowsPlaylistRequest build()

The request build method.

Returns:

A custom CheckIfUserFollowsPlaylistRequest.

self

protected CheckIfUserFollowsPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Boolean[], CheckIfUserFollowsPlaylistRequest.Builder>

Returns:

This instance.