shared/com.nubasu.spotify.webapi.wrapper.api.users/UsersApis

UsersApis

class UsersApis(client: HttpClient = HttpClient(CIO) { install(ContentNegotiation) { json() } })

User profile and follow domain API for Spotify Web API.

Covers current user profile, top items, follows, and public user profiles.

Constructors

Link copied to clipboard
constructor(client: HttpClient = HttpClient(CIO) { install(ContentNegotiation) { json() } })

Functions

Link copied to clipboard
suspend fun checkIfCurrentUserFollowsPlaylist(playlistId: String, ids: List<String>): SpotifyApiResponse<List<Boolean>>

Checks whether specific users follow a Spotify playlist.

Link copied to clipboard
suspend fun checkIfUserFollowsArtistsOrUsers(type: FollowType, ids: List<String>): SpotifyApiResponse<List<Boolean>>

Checks whether the current user follows the specified artists or users.

Link copied to clipboard
suspend fun followArtistsOrUsers(type: FollowType, ids: List<String>): SpotifyApiResponse<Boolean>

Follows artists or users for the current user.

Link copied to clipboard
suspend fun followPlaylist(playlistId: String, public: Boolean = true): SpotifyApiResponse<Boolean>

Follows a Spotify playlist for the current user.

Link copied to clipboard
suspend fun getCurrentUsersProfile(): SpotifyApiResponse<User>

Gets the Spotify profile of the current user.

Link copied to clipboard
suspend fun getFollowedArtists(type: FollowType = FollowType.ARTIST, limit: Int? = null, after: String? = null): SpotifyApiResponse<FollowedArtists>

Gets artists followed by the current user.

Link copied to clipboard
suspend fun getUsersProfile(userId: String): SpotifyApiResponse<UsersProfile>

Gets the public Spotify profile for a user.

Link copied to clipboard
suspend fun getUsersTopItems(type: TopItemType, timeRange: TimeRange? = null, limit: Int? = null, offset: Int? = null): SpotifyApiResponse<UsersTopItems>

Gets the current user's top artists or tracks.

Link copied to clipboard
suspend fun unfollowArtistsOrUsers(type: FollowType, ids: List<String>): SpotifyApiResponse<Boolean>

Unfollows artists or users for the current user.

Link copied to clipboard
suspend fun unfollowPlaylist(playlistId: String): SpotifyApiResponse<Boolean>

Unfollows a Spotify playlist for the current user.