<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<base data-ice="baseUrl">

<title data-ice="title">Reference | @kkbox/kkbox-js-sdk</title>

<link type="text/css" rel="stylesheet" href="css/style.css">

<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">

<script src="script/prettify/prettify.js"></script>

<script src="script/manual.js"></script>

<meta name="description" content="KKBOX Open API Developer SDK for JavaScript"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="@kkbox/kkbox-js-sdk"><meta property="twitter:description" content="KKBOX Open API Developer SDK for JavaScript"></head>

<body class="layout-container" data-ice="rootContainer">

<header>

<a href="./">Home</a>

<a href="identifiers.html">Reference</a>

<a href="source.html">Source</a>

<div class="search-box">

<span>

<img src="./image/search.png">

<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>

</span>

<ul class="search-result"></ul>

</div>

<a style="position:relative; top:3px;" href="https://github.com/KKBOX/OpenAPI-JavaScript"><img width="20px" src="./image/github.png"></a></header>

<nav class="navigation" data-ice="nav"><div>

<ul>

<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#api">api</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/AlbumFetcher.js~AlbumFetcher.html">AlbumFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/Api.js~Api.html">Api</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html">ArtistFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/ChartFetcher.js~ChartFetcher.html">ChartFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/FeaturedPlaylistCategoryFetcher.js~FeaturedPlaylistCategoryFetcher.html">FeaturedPlaylistCategoryFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/FeaturedPlaylistFetcher.js~FeaturedPlaylistFetcher.html">FeaturedPlaylistFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/Fetcher.js~Fetcher.html">Fetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/GenreStationFetcher.js~GenreStationFetcher.html">GenreStationFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/HttpClient.js~HttpClient.html">HttpClient</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/MoodStationFetcher.js~MoodStationFetcher.html">MoodStationFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/NewHitsPlaylistFetcher.js~NewHitsPlaylistFetcher.html">NewHitsPlaylistFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/NewReleaseCategoryFetcher.js~NewReleaseCategoryFetcher.html">NewReleaseCategoryFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/SearchFetcher.js~SearchFetcher.html">SearchFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/SharedPlaylistFetcher.js~SharedPlaylistFetcher.html">SharedPlaylistFetcher</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/api/TrackFetcher.js~TrackFetcher.html">TrackFetcher</a></span></span></li>

<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#auth">auth</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/Auth.js~Auth.html">Auth</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/ClientCredentialsFlow.js~ClientCredentialsFlow.html">ClientCredentialsFlow</a></span></span></li>

<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/auth/TokenFetcher.js~TokenFetcher.html">TokenFetcher</a></span></span></li>

</ul>

</div>

</nav>

<div class="content" data-ice="content"><h1>References</h1>

<div class="identifiers-wrap">

<div>

<div data-ice="dirSummaryWrap">

<h2 data-ice="dirPath" id="api">api</h2>

<div data-ice="dirSummary"><table class="summary" data-ice="summary">

<thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead>

<tbody>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/AlbumFetcher.js~AlbumFetcher.html">AlbumFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Fetch metadata and tracks of a album.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/Api.js~Api.html">Api</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Fetch KKBOX resources.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html">ArtistFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Get artist metadata.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/ChartFetcher.js~ChartFetcher.html">ChartFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>The fetcher that can fetch chart playlists.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/FeaturedPlaylistCategoryFetcher.js~FeaturedPlaylistCategoryFetcher.html">FeaturedPlaylistCategoryFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>List featured playlist categories.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/FeaturedPlaylistFetcher.js~FeaturedPlaylistFetcher.html">FeaturedPlaylistFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>List all featured playlists.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/Fetcher.js~Fetcher.html">Fetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Base api fetcher.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/GenreStationFetcher.js~GenreStationFetcher.html">GenreStationFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Get genre stations.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/HttpClient.js~HttpClient.html">HttpClient</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Do request to open api server with authorization header and error catch.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/MoodStationFetcher.js~MoodStationFetcher.html">MoodStationFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Get mood stations.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/NewHitsPlaylistFetcher.js~NewHitsPlaylistFetcher.html">NewHitsPlaylistFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>List new hits playlists.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/NewReleaseCategoryFetcher.js~NewReleaseCategoryFetcher.html">NewReleaseCategoryFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>List categories of new release albums.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/SearchFetcher.js~SearchFetcher.html">SearchFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Search API.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/SharedPlaylistFetcher.js~SharedPlaylistFetcher.html">SharedPlaylistFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Get playlist metadata.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/api/TrackFetcher.js~TrackFetcher.html">TrackFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Get metadata of a track.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

</tbody>

</table>

</div>

</div>

<div data-ice="dirSummaryWrap">

<h2 data-ice="dirPath" id="auth">auth</h2>

<div data-ice="dirSummary"><table class="summary" data-ice="summary">

<thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead>

<tbody>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/auth/Auth.js~Auth.html">Auth</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Implements various KKBOX OAuth 2.0 authorization flows.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/auth/ClientCredentialsFlow.js~ClientCredentialsFlow.html">ClientCredentialsFlow</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Implements the client credentials flow.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

<tr data-ice="target">

<td>

<span class="access" data-ice="access">public</span>

<span class="override" data-ice="override"></span>

</td>

<td>

<div>

<p>

<span data-ice="kind-icon" class="kind-class">C</span>

<span class="code" data-ice="name"><span><a href="class/src/auth/TokenFetcher.js~TokenFetcher.html">TokenFetcher</a></span></span>

</p>

</div>

<div>

<div data-ice="description"><p>Fetches access token.</p>

</div>

</div>

</td>

<td>

</td>

</tr>

</tbody>

</table>

</div>

</div>

</div>

<div class="identifier-dir-tree" data-ice="dirTreeWrap">

<div class="identifier-dir-tree-header">Directories</div>

<div class="identifier-dir-tree-content" data-ice="dirTree"><div style="padding-left: 0em"><a href="#api">api</a></div>

<div style="padding-left: 0em"><a href="#auth">auth</a></div></div>

</div>

</div>

</div>

<footer class="footer">

Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>

</footer>

<script src="script/search_index.js"></script>

<script src="script/search.js"></script>

<script src="script/pretty-print.js"></script>

<script src="script/inherited-summary.js"></script>

<script src="script/test-summary.js"></script>

<script src="script/inner-link.js"></script>

<script src="script/patch-for-local.js"></script>

</body>

</html>