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

public class | source

SearchFetcher

Fetcher → SearchFetcher

Search API.

Method Summary

Public Methods
public	fetchSearchResult(limit: number, offset: number): Promise Fetch the search result.
public	filter(conditions: Object): Search Filter what you don't want when search.
public	setSearchCriteria(q: string, type: string): Search Init the search fetcher for the artist, album, track or playlist.

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 the search result.

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

api.searchFetcher
 .setSearchCriteria('五月天 好好')
 .fetchSearchResult();

Filter what you don't want when search.

Name	Type	Attribute	Description
conditions	Object	optional	search conditions.
conditions.track	string		track's name.
conditions.album	string		album's name.
conditions.artist	string		artist's name.
conditions.playlist	string		playlist's title.
conditions.availableTerritory	string		tracks and albums available territory.

api.searchFetcher
 .setSearchCriteria('五月天 好好')
 .filter({artist: '五月天'})
 .fetchSearchResult();

Init the search fetcher for the artist, album, track or playlist.

Name	Type	Attribute	Description
q	string		The keyword to be searched.
type	string	optional	['artist', 'album', 'track', 'playlist'] The type of search. Default to search all types. If you want to use multiple type at the same time, you may use ',' to separate them.