ClientFollowingApi

class ClientFollowingApi(api: GenericSpotifyApi) : FollowingApi

These endpoints allow you manage the artists, users and playlists that a Spotify user follows.

Api Reference

Constructors

ClientFollowingApi

common

fun ClientFollowingApi(api: GenericSpotifyApi)

Functions

areFollowingPlaylist

common

suspend fun areFollowingPlaylist(playlist: String, vararg users: String): List<Boolean>

Check to see if one or more Spotify users are following a specified playlist.

areFollowingPlaylistRestAction

common

fun areFollowingPlaylistRestAction(playlist: String, vararg users: String): SpotifyRestAction<List<Boolean>>

Check to see if one or more Spotify users are following a specified playlist.

equals

common

open operator fun equals(other: Any?): Boolean

followArtist

common

suspend fun followArtist(artistId: String)

Add the current user as a follower of an artistRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followArtistRestAction

common

fun followArtistRestAction(artistId: String): SpotifyRestAction<Unit>

Add the current user as a follower of an artistRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followArtists

common

suspend fun followArtists(vararg artists: String)

Add the current user as a follower of other artistsRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followArtistsRestAction

common

fun followArtistsRestAction(vararg artists: String): SpotifyRestAction<Unit>

Add the current user as a follower of other artistsRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followPlaylist

common

suspend fun followPlaylist(playlist: String, followPublicly: Boolean = true): String

Add the current user as a follower of a playlist.

followPlaylistRestAction

common

fun followPlaylistRestAction(playlist: String, followPublicly: Boolean): SpotifyRestAction<String>

Add the current user as a follower of a playlist.

followUser

common

suspend fun followUser(user: String)

Add the current user as a follower of another userRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followUserRestAction

common

fun followUserRestAction(user: String): SpotifyRestAction<Unit>

Add the current user as a follower of another userRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followUsers

common

suspend fun followUsers(vararg users: String)

Add the current user as a follower of other usersRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

followUsersRestAction

common

fun followUsersRestAction(vararg users: String): SpotifyRestAction<Unit>

Add the current user as a follower of other usersRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

getFollowedArtists

common

suspend fun getFollowedArtists(limit: Int? = api.spotifyApiOptions.defaultLimit, after: String? = null): CursorBasedPagingObject<Artist>

Get the current user’s followed artists.

getFollowedArtistsRestAction

common

fun getFollowedArtistsRestAction(limit: Int? = api.spotifyApiOptions.defaultLimit, after: String? = null): SpotifyRestAction<CursorBasedPagingObject<Artist>>

Get the current user’s followed artists.

hashCode

common

open fun hashCode(): Int

isFollowingArtist

common

suspend fun isFollowingArtist(artist: String): Boolean

Check to see if the current user is following a Spotify artist.

isFollowingArtistRestAction

common

fun isFollowingArtistRestAction(artist: String): SpotifyRestAction<Boolean>

Check to see if the current user is following a Spotify artist.

isFollowingArtists

common

suspend fun isFollowingArtists(vararg artists: String): List<Boolean>

Check to see if the current user is following one or more artists.

isFollowingArtistsRestAction

common

fun isFollowingArtistsRestAction(vararg artists: String): SpotifyRestAction<List<Boolean>>

Check to see if the current user is following one or more artists.

isFollowingPlaylist

common

suspend fun isFollowingPlaylist(playlistId: String): Boolean

Check to see if the current Spotify user is following the specified playlist.

suspend fun isFollowingPlaylist(playlist: String, user: String): Boolean

Check to see if a specific Spotify user is following the specified playlist.

isFollowingPlaylistRestAction

common

fun isFollowingPlaylistRestAction(playlistId: String): SpotifyRestAction<Boolean>

Check to see if the current Spotify user is following the specified playlist.

fun isFollowingPlaylistRestAction(playlist: String, user: String): SpotifyRestAction<Boolean>

Check to see if a specific Spotify user is following the specified playlist.

isFollowingUser

common

suspend fun isFollowingUser(user: String): Boolean

Check to see if the current user is following another Spotify user.

isFollowingUserRestAction

common

fun isFollowingUserRestAction(user: String): SpotifyRestAction<Boolean>

Check to see if the current user is following another Spotify user.

isFollowingUsers

common

suspend fun isFollowingUsers(vararg users: String): List<Boolean>

Check to see if the current user is following one or more other Spotify users.

isFollowingUsersRestAction

common

fun isFollowingUsersRestAction(vararg users: String): SpotifyRestAction<List<Boolean>>

Check to see if the current user is following one or more other Spotify users.

toString

common

open fun toString(): String

unfollowArtist

common

suspend fun unfollowArtist(artist: String)

Remove the current user as a follower of an artistRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowArtistRestAction

common

fun unfollowArtistRestAction(artist: String): SpotifyRestAction<Unit>

Remove the current user as a follower of an artistRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowArtists

common

suspend fun unfollowArtists(vararg artists: String)

Remove the current user as a follower of artistsRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowArtistsRestAction

common

fun unfollowArtistsRestAction(vararg artists: String): SpotifyRestAction<Unit>

Remove the current user as a follower of artistsRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowPlaylist

common

suspend fun unfollowPlaylist(playlist: String): String

Remove the current user as a follower of a playlist.

unfollowPlaylistRestAction

common

fun unfollowPlaylistRestAction(playlist: String): SpotifyRestAction<String>

Remove the current user as a follower of a playlist.

unfollowUser

common

suspend fun unfollowUser(user: String)

Remove the current user as a follower of another userRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowUserRestAction

common

fun unfollowUserRestAction(user: String): SpotifyRestAction<Unit>

Remove the current user as a follower of another userRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowUsers

common

suspend fun unfollowUsers(vararg users: String)

Remove the current user as a follower of other usersRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

unfollowUsersRestAction

common

fun unfollowUsersRestAction(vararg users: String): SpotifyRestAction<Unit>

Remove the current user as a follower of other usersRequires the SpotifyScope.USER_FOLLOW_MODIFY scopeApi Reference

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

(source)