deezer-client-kt

2.0.0

deezer-client-kt/io.github.kingg22.deezer.client.api.objects

Package-level declarations

Types

class Album @JvmOverloads constructor(val id: Long, val title: String, val upc: String? = null, val link: String? = null, val share: String? = null, val cover: String? = null, val coverSmall: String? = null, val coverMedium: String? = null, val coverBig: String? = null, val coverXl: String? = null, val md5Image: String? = null, val genreId: Long? = null, val genres: PaginatedResponse<Genre>? = null, val label: String? = null, val trackCount: Int? = null, val duration: Int? = null, val fans: Int? = null, val rating: Int? = null, val releaseDate: LocalDate? = null, val recordType: String? = null, val isAvailable: Boolean? = null, val alternative: Album? = null, val tracklist: String? = null, val isExplicitLyrics: Boolean? = null, val explicitContentLyrics: Explicit? = null, val explicitContentCover: Explicit? = null, val position: Int? = null, val contributors: List<Artist>? = null, val artist: Artist? = null, val tracks: PaginatedResponse<Track>? = null, val type: String = "album") : Resource

Represents an Album object of Deezer API.

class Artist @JvmOverloads constructor(val id: Long, val name: String, val link: String? = null, val share: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val albumCount: Int? = null, val fansCount: Int? = null, val isRadio: Boolean? = null, val tracklist: String? = null, val type: String = "artist", val role: String? = null, val position: Int? = null) : Resource

Represents an Artist object of Deezer API.

class Chart @JvmOverloads constructor(val tracks: PaginatedResponse<Track> = PaginatedResponse(), val albums: PaginatedResponse<Album> = PaginatedResponse(), val artists: PaginatedResponse<Artist> = PaginatedResponse(), val playlists: PaginatedResponse<Playlist> = PaginatedResponse(), val podcasts: PaginatedResponse<Podcast> = PaginatedResponse())

Charts of a specified genre

class Editorial @JvmOverloads constructor(val id: Long, val name: String, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val type: String = "editorial") : Resource

Represents an editorial object of Deezer API.

class Episode @JvmOverloads constructor(val id: Long, val title: String, val duration: Int, val releaseDate: LocalDateTime, val description: String? = null, val isAvailable: Boolean? = null, val link: String? = null, val share: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val trackToken: String? = null, val podcast: Podcast? = null, val type: String = "episode") : Resource

Represent an episode object of Deezer API.

internal class ErrorContainer(val error: ErrorContainer.ErrorDetail)

Represent the error response of Deezer API.

@Serializable(with = Explicit.ExplicitSerializer::class)

enum Explicit : Enum<Explicit>

Represent the explicit levels of Deezer API.

class Genre @JvmOverloads constructor(val id: Long, val name: String, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val type: String = "genre", val radios: List<Radio>? = null) : Resource

Represents an Genre object of Deezer API.

enum ImageSizes : Enum<ImageSizes>

Unofficial Represents the size of the image.

class Infos @JvmOverloads constructor(val countryIso: String, val country: String, val isOpen: Boolean, val offers: List<JsonElement> = emptyList(), val pop: String? = null, val uploadToken: String? = null, val uploadTokenLifetime: Int? = null, val userToken: String? = null, val hosts: Infos.HostDetails? = null, val ads: JsonObject? = null, val hasPodcast: Boolean? = null)

Represent the information about the Deezer API in the current country.

class Options @JvmOverloads constructor(val isStreaming: Boolean, val streamingDuration: Int, val isOffline: Boolean, val isHq: Boolean, val isAdsDisplay: Boolean, val isAdsAudio: Boolean, val isTooManyDevices: Boolean, val isCanSubscribe: Boolean, val radioSkips: Int, val isLossless: Boolean, val isPreview: Boolean, val isRadio: Boolean, val type: String = "options")

Represents an User's Options of Deezer API.

PaginatedResponse

data class PaginatedResponse<T : @Serializable Any> @JvmOverloads constructor(val data: List<T> = emptyList(), val checksum: String? = null, val total: Int? = null, val prev: String? = null, val next: String? = null)

Unofficial Represent a response of Deezer API.

PaginatedResponses

@ExperimentalDeezerClient

internal object PaginatedResponses

Helper that provides utilities for handling paginated responses in Java code.

class Playlist @JvmOverloads constructor(val id: Long, val title: String, val isPublic: Boolean, val description: String? = null, val duration: Int? = null, val link: String, val creator: User, val isLovedTrack: Boolean? = null, val isCollaborative: Boolean? = null, val rating: Int? = null, val trackCount: Int? = null, val unseenTrackCount: Int? = null, val fanCount: Int? = null, val share: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val checksum: String? = null, val tracks: PaginatedResponse<Track>? = null, val creationDate: LocalDateTime? = null, val md5Image: String? = null, val pictureType: String? = null, val type: String = "playlist", val position: Int? = null, val tracklist: String? = null) : Resource

Represents a Playlist object of Deezer API.

class Podcast @JvmOverloads constructor(val id: Long, val title: String? = null, val description: String? = null, val isAvailable: Boolean? = null, val fans: Int? = null, val link: String? = null, val share: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val type: String = "podcast") : Resource

A podcast object of Deezer API.

class Radio @JvmOverloads constructor(val id: Long, val title: String, val description: String? = null, val share: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val tracklist: String? = null, val md5Image: String? = null, val type: String = "radio") : Resource

Represent a radio object of Deezer API.

interface Resource

Internal Represents a Resource of Deezer API.

@ExperimentalDeezerClient

internal object Resources

Helper that provides utilities for handling reload resources in Java code.

enum SearchOrder : Enum<SearchOrder>

Represent the order enum for search on Deezer API.

SearchUserHistory

class SearchUserHistory @JvmOverloads constructor(val tracks: List<Track> = emptyList(), val albums: List<Album> = emptyList(), val artists: List<Artist> = emptyList(), val playlists: List<Playlist> = emptyList(), val podcasts: List<Podcast> = emptyList(), val radio: List<Radio> = emptyList())

Represent the response of the user's search history on Deezer API.

class Track @JvmOverloads constructor(val id: Long, val title: String, val titleShort: String, val duration: Int, val rank: Int, val preview: String, val artist: Artist, val isReadable: Boolean? = null, val titleVersion: String? = null, val isUnseen: Boolean? = null, val isrc: String? = null, val link: String? = null, val share: String? = null, val trackPosition: Int? = null, val diskNumber: Int? = null, val releaseDate: LocalDate? = null, val isExplicitLyrics: Boolean, val explicitContentLyrics: Explicit? = null, val explicitContentCover: Explicit? = null, val bpm: Float? = null, val gain: Float? = null, val availableCountries: List<String>? = null, val alternative: Track? = null, val contributors: List<Artist>? = null, val md5Image: String? = null, val trackToken: String? = null, val album: Album? = null, val type: String = "track", val position: Int? = null, val timeAdd: Long? = null) : Resource

Represents a Track object of Deezer API.

class User @JvmOverloads constructor(val id: Long, val name: String, val lastname: String? = null, val firstname: String? = null, val email: String? = null, val status: Int? = null, val birthday: LocalDate? = null, val inscriptionDate: LocalDate? = null, val gender: User.Gender? = null, val link: String? = null, val picture: String? = null, val pictureSmall: String? = null, val pictureMedium: String? = null, val pictureBig: String? = null, val pictureXl: String? = null, val country: String? = null, val lang: String? = null, val isKid: Boolean? = null, val explicitContentLevel: String? = null, val explicitContentLevelsAvailable: List<User.ExplicitContentLevels>? = null, val tracklist: String? = null, val type: String = "user") : Resource

Represents an User object of Deezer API.

Properties

internal const val IMAGE_PATH_END: String

Functions

@AfterInitialize

internal fun Resource.client(): DeezerApiClient

The io.github.kingg22.deezer.client.api.DeezerApiClient to make operations easy in Resource

@AfterInitialize

inline suspend fun <N : @Serializable Any> PaginatedResponse<N>.fetchNext(expand: Boolean = false): PaginatedResponse<N>?

Fetch the next page of the search

@AfterInitialize

inline suspend fun <P : @Serializable Any> PaginatedResponse<P>.fetchPrevious(expand: Boolean = false): PaginatedResponse<P>?

Fetch the previous page of the search

retrieveImageUrl

fun Album.retrieveImageUrl(): String

Retrieve the image url of the album.

fun Playlist.retrieveImageUrl(): String

Retrieve the image url of the playlist.

fun Radio.retrieveImageUrl(): String

Retrieve the image url of the radio.

fun Track.retrieveImageUrl(): String

Retrieve the image url of the track.

fun URLBuilder.withImageSize(size: ImageSizes)

Concatenate the path segment of the image size.

fun URLBuilder.withImageSize(size: Int)

Concatenate the path segment of the image size. Format /'size'x'size'-000000-80-0-0.jpg

fun Url.withImageSize(size: ImageSizes): Url

fun Url.withImageSize(size: Int): Url

Retrieve the url with the size of the image.

fun String.withImageSize(size: ImageSizes): String

fun String.withImageSize(size: Int): String

Retrieve the string with the size of the image.