const Base = require('../Base.js');
const Track = require('./Track.js');
class Playlist extends Base {
/**
* Represents the playlist.
* @param {Spotify} spotify - The spotify client.
* @param {object} data - The playlist object data.
* @extends {Base}
*/
constructor(spotify, data) {
super(data);
/**
* The tracks of the playlist.
* @type {Track[]|undefined}
*/
if (data.tracks && data.tracks.items) {
this.tracks = data.tracks.items.map((t) => new Track(spotify, t));
}
/**
* The spotify client.
* @type {Spotify}
*/
this.spotify = spotify;
}
/**
* Shortcut to play the playlist.
* @param {StartOptions} options
* @returns {Promise<Status|HTTPError|ApiError>}
*/
play(options = {}) {
return this.spotify.player.start(this.uri, options);
}
/**
* Shortcut to modify the playlist.
* @param {ModifyOptions} options
* @returns {Promise<Status|HTTPError|ApiError>}
*/
modify(options = {}) {
return this.spotify.playlists.modify(this.id, options);
}
/**
* Shortcut to add tracks to a playlist.
* @param {string|string[]} uris - A list of Spotify URIs to add, can be track or episode URIs.
* @param {number} [position=0] - The position to insert the items, a zero-based index.
* @returns {Promise<Status|HTTPError|ApiError>}
*/
add(uris, position = 0) {
return this.spotify.playlists.add(this.id, uris, position);
}
/**
* Shortcut to remove a track from a playlist.
* @param {string|string[]} uris - A list of Spotify URIs to remove, can be track or episode URIs. Maximum: 100
* @param {string} [snapshot] - The playlist's snapshot ID against which you want to make the changes.
* @returns {Promise<Status|HTTPError|ApiError>}
*/
remove(uris, snapshot) {
return this.spotify.playlists.remove(this.id, uris, snapshot);
}
/**
* Shortcut to follow the playlist.
* @returns {Promise<Status|HTTPError|ApiError>}
*/
follow() {
return this.spotify.playlists.follow(this.id);
}
/**
* Shortcut to unfollow the playlist.
* @returns {Promise<Status|HTTPError|ApiError>}
*/
unfollow() {
return this.spotify.playlists.unfollow(this.id);
}
/**
* Shortcut to check user's following the playlist.
* @param {string|string[]} users - A list of Spotify User IDs.
* @returns {Promise<boolean[]|HTTPError|ApiError>}
*/
following(users) {
return this.spotify.playlists.following(this.id, users);
}
/**
* Shortcut to upload cover art to a playlist.
* @param {string} [image] - The Base64 image encoded to upload as cover art.
* @returns {Promise<Image|Status|HTTPError|ApiError>}
*/
cover(image) {
return this.spotify.playlists.cover(this.id, image);
}
}
module.exports = Playlist;