SimpleAlbum

data class SimpleAlbum(albumTypeString: String, availableMarketsString: List<String>, externalUrlsString: Map<String, String>, href: String, id: String, uri: SpotifyUri, artists: List<SimpleArtist>, images: List<SpotifyImage>, name: String, type: String, restrictions: Restrictions?, releaseDateString: String, releaseDatePrecisionString: String, totalTracks: Int?, albumGroupString: String?) : CoreObject

Simplified Album object that can be used to retrieve a full Album

Parameters

href

A link to the Web API endpoint providing full details of the album.

The Spotify ID for the album. are “album”, “single”, “compilation”, “appears_on”. Compare to album_type this field represents relationship between the artist and the album.

artists

The artists of the album. Each artist object includes a link in href to more detailed information about the artist. that an album is considered available in a market when at least 1 of its tracks is available in that market.

images

The cover art for the album in various sizes, widest first.

name

The name of the album. In case of an album takedown, the value may be an empty string.

type

The object type: “album” it might be shown as 1981-12 or 1981-12-15.

releaseDatePrecisionString

The precision with which release_date value is known: year , month , or day.

restrictions

Part of the response when Track Relinking is applied, the original track is not available in the given market, and Spotify did not have any tracks to relink it with. The track response will still contain metadata for the original track, and a restrictions object containing the reason why the track is not available: "restrictions" : {"reason" : "market"}

Constructors

SimpleAlbum

common

fun SimpleAlbum(albumTypeString: String, availableMarketsString: List<String> = listOf(), externalUrlsString: Map<String, String>, href: String, id: String, uri: SpotifyUri, artists: List<SimpleArtist>, images: List<SpotifyImage>, name: String, type: String, restrictions: Restrictions? = null, releaseDateString: String, releaseDatePrecisionString: String, totalTracks: Int? = null, albumGroupString: String? = null)

A link to the Web API endpoint providing full details of the album.

Functions

component10

common

operator fun component10(): String

component11

common

operator fun component11(): Restrictions?

component13

common

operator fun component13(): String

component14

common

operator fun component14(): Int?

component4

common

operator fun component4(): String

component5

common

operator fun component5(): String

component6

common

operator fun component6(): SpotifyUri

component7

common

operator fun component7(): List<SimpleArtist>

component8

common

operator fun component8(): List<SpotifyImage>

component9

common

operator fun component9(): String

copy

common

fun copy(albumTypeString: String, availableMarketsString: List<String> = listOf(), externalUrlsString: Map<String, String>, href: String, id: String, uri: SpotifyUri, artists: List<SimpleArtist>, images: List<SpotifyImage>, name: String, type: String, restrictions: Restrictions? = null, releaseDateString: String, releaseDatePrecisionString: String, totalTracks: Int? = null, albumGroupString: String? = null): SimpleAlbum

equals

common

open operator override fun equals(other: Any?): Boolean

getMembersThatNeedApiInstantiation

common

open override fun getMembersThatNeedApiInstantiation(): List<NeedsApi?>

hashCode

common

open override fun hashCode(): Int

toFullAlbum

common

suspend fun toFullAlbum(market: Market? = null): Album?

Converts this SimpleAlbum into a full Album object with the given market

toFullAlbumRestAction

common

fun toFullAlbumRestAction(market: Market? = null): SpotifyRestAction<Album?>

Converts this SimpleAlbum into a full Album object with the given market

toString

common

open override fun toString(): String

Properties

albumGroup

common

val albumGroup: AlbumResultType?

Optional.

albumType

common

val albumType: AlbumResultType

The type of the album: one of “album”, “single”, or “compilation”.

api

common

lateinit var api: GenericSpotifyApi

The API client associated with the request

artists

common

val artists: List<SimpleArtist>

The artists of the album.

availableMarkets

common

val availableMarkets: List<Market>

The markets in which the album is available: ISO 3166-1 alpha-2 country codes.

externalUrls

common

val externalUrls: List<ExternalUrl>

Known external URLs for this object

href

common

open override val href: String

A link to the Web API endpoint providing full details of the album.

common

open override val id: String

The Spotify ID for the album.

images

common

val images: List<SpotifyImage>

The cover art for the album in various sizes, widest first.

name

common

val name: String

The name of the album.

releaseDate

common

val releaseDate: ReleaseDate

The date the album was first released, for example 1981.

releaseDatePrecisionString

common

val releaseDatePrecisionString: String

The precision with which release_date value is known: year , month , or day.

restrictions

common

val restrictions: Restrictions? = null

Part of the response when Track Relinking is applied, the original track is not available in the given market, and Spotify did not have any tracks to relink it with.

totalTracks

common

val totalTracks: Int? = null

type

common

val type: String

The object type: “album” it might be shown as 1981-12 or 1981-12-15.

uri

common

open override val uri: SpotifyUri

The URI associated with the object

Sources

(source)