@kkbox/kkbox-js-sdk
Version:
KKBOX Open API developer SDK for JavaScript. Use it to easily access KKBOX open API to get various metadata about KKBOX's tracks, albums, artists, playlists and stations.
257 lines (244 loc) • 19 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="">
<title data-ice="title">Source | API Document</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>
</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>
<a data-ice="repoURL" href="https://github.com/KKBOX/OpenAPI-JavaScript" class="repo-url-github">Repository</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>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">api</div><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"><div data-ice="dirPath" class="nav-dir-path">auth</div><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>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">79/82</span></h1>
<table class="files-summary" data-ice="files" data-use-coverage="true">
<thead>
<tr>
<td>File</td>
<td>Identifier</td>
<td class="coverage">Document</td>
<td style="display: none;">Size</td>
<td style="display: none;">Lines</td>
<td style="display: none;">Updated</td>
</tr>
</thead>
<tbody>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/Endpoint.js.html">src/Endpoint.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">1446 byte</td>
<td style="display: none;" data-ice="lines">83</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/SDK.js.html">src/SDK.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">84 byte</td>
<td style="display: none;" data-ice="lines">1</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/AlbumFetcher.js.html">src/api/AlbumFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/AlbumFetcher.js~AlbumFetcher.html">AlbumFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2105 byte</td>
<td style="display: none;" data-ice="lines">68</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/Api.js.html#errorLines=27,28">src/api/Api.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/Api.js~Api.html">Api</a></span></td>
<td class="coverage"><span data-ice="coverage">87 %</span><span data-ice="coverageCount" class="coverage-count">14/16</span></td>
<td style="display: none;" data-ice="size">3101 byte</td>
<td style="display: none;" data-ice="lines">95</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/ArtistFetcher.js.html">src/api/ArtistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/ArtistFetcher.js~ArtistFetcher.html">ArtistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2448 byte</td>
<td style="display: none;" data-ice="lines">76</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/ChartFetcher.js.html">src/api/ChartFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/ChartFetcher.js~ChartFetcher.html">ChartFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">706 byte</td>
<td style="display: none;" data-ice="lines">27</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/FeaturedPlaylistCategoryFetcher.js.html">src/api/FeaturedPlaylistCategoryFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/FeaturedPlaylistCategoryFetcher.js~FeaturedPlaylistCategoryFetcher.html">FeaturedPlaylistCategoryFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2628 byte</td>
<td style="display: none;" data-ice="lines">70</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/FeaturedPlaylistFetcher.js.html">src/api/FeaturedPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/FeaturedPlaylistFetcher.js~FeaturedPlaylistFetcher.html">FeaturedPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">1032 byte</td>
<td style="display: none;" data-ice="lines">31</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/Fetcher.js.html">src/api/Fetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/Fetcher.js~Fetcher.html">Fetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">2959 byte</td>
<td style="display: none;" data-ice="lines">87</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/GenreStationFetcher.js.html">src/api/GenreStationFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/GenreStationFetcher.js~GenreStationFetcher.html">GenreStationFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">1942 byte</td>
<td style="display: none;" data-ice="lines">59</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/HttpClient.js.html">src/api/HttpClient.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/HttpClient.js~HttpClient.html">HttpClient</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">1202 byte</td>
<td style="display: none;" data-ice="lines">47</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/MoodStationFetcher.js.html#errorLines=42">src/api/MoodStationFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/MoodStationFetcher.js~MoodStationFetcher.html">MoodStationFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">80 %</span><span data-ice="coverageCount" class="coverage-count">4/5</span></td>
<td style="display: none;" data-ice="size">1650 byte</td>
<td style="display: none;" data-ice="lines">54</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/NewHitsPlaylistFetcher.js.html">src/api/NewHitsPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/NewHitsPlaylistFetcher.js~NewHitsPlaylistFetcher.html">NewHitsPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">1865 byte</td>
<td style="display: none;" data-ice="lines">57</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/NewReleaseCategoryFetcher.js.html">src/api/NewReleaseCategoryFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/NewReleaseCategoryFetcher.js~NewReleaseCategoryFetcher.html">NewReleaseCategoryFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2749 byte</td>
<td style="display: none;" data-ice="lines">76</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/SearchFetcher.js.html">src/api/SearchFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/SearchFetcher.js~SearchFetcher.html">SearchFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">7071 byte</td>
<td style="display: none;" data-ice="lines">165</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/SharedPlaylistFetcher.js.html">src/api/SharedPlaylistFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/SharedPlaylistFetcher.js~SharedPlaylistFetcher.html">SharedPlaylistFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2262 byte</td>
<td style="display: none;" data-ice="lines">68</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/api/TrackFetcher.js.html">src/api/TrackFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/api/TrackFetcher.js~TrackFetcher.html">TrackFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">1412 byte</td>
<td style="display: none;" data-ice="lines">51</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/Auth.js.html">src/auth/Auth.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/Auth.js~Auth.html">Auth</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
<td style="display: none;" data-ice="size">736 byte</td>
<td style="display: none;" data-ice="lines">25</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/ClientCredentialsFlow.js.html">src/auth/ClientCredentialsFlow.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/ClientCredentialsFlow.js~ClientCredentialsFlow.html">ClientCredentialsFlow</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">617 byte</td>
<td style="display: none;" data-ice="lines">25</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/auth/TokenFetcher.js.html">src/auth/TokenFetcher.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/auth/TokenFetcher.js~TokenFetcher.html">TokenFetcher</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">916 byte</td>
<td style="display: none;" data-ice="lines">39</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/catchError.js.html">src/catchError.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">307 byte</td>
<td style="display: none;" data-ice="lines">16</td>
<td style="display: none;" data-ice="updated">2017-10-05 10:30:30 (UTC)</td>
</tr>
</tbody>
</table>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</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>