kkbox_openapi library API

The library implements a client for KKBOX's Open API.

Most of these API are for basic metadata and public listing, such as metadata about tracks, albums, artists and playlists.

To access these API, you need a valid AccessToken. To learn about how to obtain an AccessToken, please take a look at the kkbox_auth library.

While calling these API, you should also pass a territory code. KKBOX presents localized data in different territories. For example, a Japanese track maybe titled in Japanese in Japan, but it might be titled in Traditional Chinese in Taiwan and Simplified Chinese in Singapore.

However, KKBOX's Open API does not help you to do Chinese conversion on the title and description of playlists. If you want the users in Singapore to read contents in Simplified Chinese, you have to do Chinese conversion by your self.

Classes

AlbumApi
Fetches metadata of an album by giving an albumId [...]
AlbumTracksApi
Fetches tracks contained in an album by giving an albumId. [...]
ArtistAlbumsApi
Fetches albums belong to an artist by giving an artistId. [...]
ArtistApi
Fetches metadata of an artist by giving an artistId [...]
ArtistRelatedArtistsApi
Fetches related artists of an artist by giving an artistId, [...]
ArtistTopTracksApi
Fetches top tracks of an artist by giving an artistId, [...]
ChartsApi
Fetches charts playlists. [...]
ChildrenCategoriesApi
Fetches categories for children contents. [...]
ChildrenCategoryApi
Fetches contents of a category of children contents. [...]
ChildrenCategoryPlaylistsApi
Fetches playlists in a category of children contents. [...]
FeaturedPlaylistsApi
Fetches featured playlists. [...]
FeaturedPlaylistsCategoriesApi
Fetch featured playlists categories. [...]
FeaturedPlaylistsCategoryApi
Fetch playlists in a featured category by giving a categoryId. [...]
GenreStationApi
Fetches tracks in a genre station by giving a stationId. [...]
GenreStationsApi
Fetch genre stations. [...]
KKBOXBaseApi<T>
A base of API used in KKBOX's Open API.
MoodStationApi
Fetches tracks in a mood station by giving a stationId. [...]
MoodStationsApi
Fetch mood stations. [...]
NewHitsPlaylistsApi
Fetches new hits playlists. [...]
NewReleasedAlbumsCategoriesApi
Fetches new released album categories. [...]
NewReleasedAlbumsCategoryApi
Fetches a new released album category by giving a categoryId. [...]
PlaylistApi
Fetches a playlist by giving a playlistId. [...]
PlaylistTracksApi
Fetches tracks contained in a playlist by giving a playlistId. [...]
SearchApi
Searches in KKBOX. [...]
TrackApi
Fetches metadata of a track by giving a trackId. [...]

Functions

baseUrl(ClientConfiguration configuration) String
searchTypeToString(SearchType aType) String
Converts a SearchType to a string.
territoryFromString(String s) Territory
Converts a string to a Territory.
territoryToString(Territory territory) String
Converts a Territory to a string.

Enums

SearchType
The types used in calling search API.
Territory
The territory where KKBOX provides services. [...]