src/api/AlbumFetcher.js
import { ALBUMS as ENDPOINT } from '../Endpoint';
import Fetcher from './Fetcher';
/**
* Fetch metadata and tracks of a album.
* @see https://docs-en.kkbox.codes/v1.1/reference#albums
*/
export default class AlbumFetcher extends Fetcher {
/**
* @ignore
*/
constructor(http, territory = 'TW') {
super(http, territory);
/**
* @ignore
*/
this.albumID = undefined;
}
/**
* Set the album fetcher.
*
* @param {string} albumID - The ID of an album.
* @return {AlbumFetcher}
* @see https://docs-en.kkbox.codes/v1.1/reference#albums-album_id
*/
setAlbumID(albumID) {
this.albumID = albumID;
return this;
}
/**
* Fetch metadata of the album you create.
*
* @return {Promise}
* @example api.albumFetcher.setAlbumID('KmRKnW5qmUrTnGRuxF').fetchMetadata();
* @see https://docs-en.kkbox.codes/v1.1/reference#albums-album_id
*/
fetchMetadata() {
return this.http.get(ENDPOINT + '/' + this.albumID, {
territory: this.territory
});
}
/**
* Get KKBOX web widget uri of the album.
* @example https://widget.kkbox.com/v1/?id=4qtXcj31wYJTRZbb23&type=album
* @return {string}
*/
getWidgetUri() {
return `https://widget.kkbox.com/v1/?id=${this.albumID}&type=album`;
}
/**
* Get tracks in an album. Result will be return with pagination.
*
* @param {number} [limit] - The size for one page.
* @param {number} [offset] - The offset index for first element.
* @return {Promise}
* @example api.albumFetcher.setAlbumID('KmRKnW5qmUrTnGRuxF').fetchTracks();
* @see https://docs-en.kkbox.codes/v1.1/reference#albums-album_id-tracks
*/
fetchTracks(limit = undefined, offset = undefined) {
return this.http.get(ENDPOINT + '/' + this.albumID + '/tracks', {
territory: this.territory,
limit: limit,
offset: offset
});
}
}