import AlbumFetcher from '@kkbox/kkbox-js-sdk/src/api/AlbumFetcher.js'

public class | source

AlbumFetcher

Fetcher → AlbumFetcher

Fetch metadata and tracks of a album.

Method Summary

Public Methods
public	fetchMetadata(): Promise Fetch metadata of the album you create.
public	fetchTracks(limit: number, offset: number): Promise Get tracks in an album.
public	getWidgetUri(): string Get KKBOX web widget uri of the album.
public	setAlbumID(albumID: string): AlbumFetcher Set the album fetcher.

From class Fetcher
public	fetchNextPage(fulfillment: fulfillment, nextUriPath: String): Promise Fetches next page of various paged APIs.
public	hasNextPage(fulfillment: fulfillment, nextUriPath: String): Boolean Is next page available for various paged APIs.
public	setTerritory(territory: string): Fetcher Set the fetcher's territory.

Fetch metadata of the album you create.

api.albumFetcher.setAlbumID('KmRKnW5qmUrTnGRuxF').fetchMetadata();

Get tracks in an album. Result will be return with pagination.

Name	Type	Attribute	Description
limit	number	optional	The size for one page.
offset	number	optional	The offset index for first element.

api.albumFetcher.setAlbumID('KmRKnW5qmUrTnGRuxF').fetchTracks();

Get KKBOX web widget uri of the album.

https://widget.kkbox.com/v1/?id=4qtXcj31wYJTRZbb23&type=album

Set the album fetcher.

Name	Type	Attribute	Description
albumID	string		The ID of an album.