Home Reference Source
import FeaturedPlaylistFetcher from '@kkbox/kkbox-js-sdk/src/api/FeaturedPlaylistFetcher.js'
public class | source

FeaturedPlaylistFetcher

Extends:

Fetcher → FeaturedPlaylistFetcher

List all featured playlists.

See:

Method Summary

Public Methods
public

Fetch all featured playlists.

Inherited Summary

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.

Public Methods

public fetchAllFeaturedPlaylists(limit: number, offset: number): Promise source

Fetch all featured playlists. Result will be paged.

Params:

NameTypeAttributeDescription
limit number
  • optional

The size for one page.

offset number
  • optional

The offset index for first element.

Return:

Promise

Example:

api.featuredPlaylistFetcher.fetchAllFeaturedPlaylists();

See: