Package com.wrapper.spotify.requests.data.follow

Class CheckUsersFollowPlaylistRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<Boolean[],CheckUsersFollowPlaylistRequest.Builder>

com.wrapper.spotify.requests.data.follow.CheckUsersFollowPlaylistRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

CheckUsersFollowPlaylistRequest

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

Builder class for building a CheckUsersFollowPlaylistRequest.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CheckUsersFollowPlaylistRequest	build()	The request build method.
CheckUsersFollowPlaylistRequest.Builder	ids(String ids)	The user IDs setter.
CheckUsersFollowPlaylistRequest.Builder	owner_id(String owner_id)	The playlists owner ID setter.
CheckUsersFollowPlaylistRequest.Builder	playlist_id(String playlist_id)	The playlist ID setter.
protected CheckUsersFollowPlaylistRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class com.wrapper.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

Constructor Details

Builder

public Builder(String accessToken)

Create a new CheckUsersFollowPlaylistRequest.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

owner_id

public CheckUsersFollowPlaylistRequest.Builder owner_id(String owner_id)

The playlists owner ID setter.

Parameters:

owner_id - The Spotify user ID of the person who owns the playlist.

Returns:

A CheckUsersFollowPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

playlist_id

public CheckUsersFollowPlaylistRequest.Builder playlist_id(String playlist_id)

The playlist ID setter.

Parameters:

playlist_id - The Spotify ID of the playlist.

Returns:

A CheckUsersFollowPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

ids

public CheckUsersFollowPlaylistRequest.Builder ids(String ids)

The user IDs setter.

Parameters:

ids - Required. A comma-separated list of Spotify User IDs; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.

Returns:

A CheckUsersFollowPlaylistRequest.Builder.

See Also:

Spotify: URIs & IDs

build

public CheckUsersFollowPlaylistRequest build()

The request build method.

Returns:

A custom CheckUsersFollowPlaylistRequest.

self

protected CheckUsersFollowPlaylistRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

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

Returns:

This instance.