spotify-api-kotlin/com.adamratzman.spotify.endpoints.client/ClientFollowingApi

ClientFollowingApi

class ClientFollowingApi(val api: GenericSpotifyApi) : FollowingApi(source)

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

Api Reference

Constructors

ClientFollowingApi

constructor(api: GenericSpotifyApi)

Properties

api

val api: GenericSpotifyApi

cache

val cache: SpotifyCache

Functions

areFollowingPlaylist

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

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

followArtist

suspend fun followArtist(artistId: String)

Add the current user as a follower of an artist

followArtists

suspend fun followArtists(vararg artists: String)

Add the current user as a follower of other artists

followPlaylist

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

Add the current user as a follower of a playlist.

followUser

suspend fun followUser(user: String)

Add the current user as a follower of another user

followUsers

suspend fun followUsers(vararg users: String)

Add the current user as a follower of other users

getFollowedArtists

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

Get the current user’s followed artists.

isFollowingArtist

suspend fun isFollowingArtist(artist: String): Boolean

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

isFollowingArtists

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

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

isFollowingPlaylist

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.

isFollowingUser

suspend fun isFollowingUser(user: String): Boolean

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

isFollowingUsers

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

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

unfollowArtist

suspend fun unfollowArtist(artist: String)

Remove the current user as a follower of an artist

unfollowArtists

suspend fun unfollowArtists(vararg artists: String)

Remove the current user as a follower of artists

unfollowPlaylist

suspend fun unfollowPlaylist(playlist: String): String

Remove the current user as a follower of a playlist.

unfollowUser

suspend fun unfollowUser(user: String)

Remove the current user as a follower of another user

unfollowUsers

suspend fun unfollowUsers(vararg users: String)

Remove the current user as a follower of other users