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

public class | source

ChartFetcher

Fetcher → ChartFetcher

The fetcher that can fetch chart playlists.

Method Summary

Public Methods
public	fetchCharts(): Promise Fetch chart playlists.
public	fetchMetadata(): Promise Fetch playlist of the chart you set.
public	fetchTracks(limit: number, offset: number): Promise Fetch tracks of the playlist with the chart fetcher you init.
public	setPlaylistID(playlistID: string): ChartFetcher Init the chart 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 chart playlists.

api.chartFetcher.fetchCharts();

Fetch playlist of the chart you set.

api.chartFetcher.setPlaylistID('4mJSYXvueA8t0odsny').fetchMetadata();

Fetch tracks of the playlist with the chart fetcher you init. Result will be paged.

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

api.chartFetcher.setPlaylistID('4mJSYXvueA8t0odsny').fetchTracks();

Init the chart fetcher.

Name	Type	Attribute	Description
playlistID	string		The playlist ID.