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

public class | source

SharedPlaylistFetcher

Fetcher → SharedPlaylistFetcher

Get playlist metadata.

Method Summary

Public Methods
public	fetchMetadata(): Promise Fetch metadata of the shared playlist with the shared playlist fetcher.
public	fetchTracks(limit: number, offset: number): Promise Fetch track list of a shared playlist.
public	getWidgetUri(): string Get KKBOX web widget uri of the playlist.
public	setPlaylistID(playlistID: string): SharedPlaylistFetcher Init the shared playlist 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 shared playlist with the shared playlist fetcher.

 api.sharedPlaylistFetcher
   .setPlaylistID('4nUZM-TY2aVxZ2xaA-')
   .fetchMetadata();

Fetch track list of a shared playlist.

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

 api.sharedPlaylistFetcher
   .setPlaylistID('4nUZM-TY2aVxZ2xaA-')
   .fetchTracks();

Get KKBOX web widget uri of the playlist.

https://widget.kkbox.com/v1/?id=KmjwNXizu5MxHFSloP&type=playlist

Init the shared playlist fetcher.

Name	Type	Attribute	Description
playlistID	string		The ID of a playlist.