SimpleEpisode

data class SimpleEpisode(audioPreviewUrl: String?, description: String?, durationMs: Int, explicit: Boolean, externalUrlsString: Map<String, String>, href: String, id: String, images: List<SpotifyImage>, isExternallyHosted: Boolean, isPlayable: Boolean, language: String?, showLanguagesPrivate: List<String>, name: String, releaseDateString: String, releaseDatePrecisionString: String, resumePoint: ResumePoint?, type: String, uri: SpotifyUri) : CoreObject

A simplified episode (podcast) on Spotify

Parameters

audioPreviewUrl

A URL to a 30 second preview (MP3 format) of the episode. null if not available.

description

A description of the episode.

durationMs

The episode length in milliseconds.

explicit

Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).

images

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

isExternallyHosted

True if the episode is hosted outside of Spotify’s CDN.

isPlayable

True if the episode is playable in the given market. Otherwise false.

name

The name of the episode.

releaseDatePrecisionString

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

resumePoint

The user’s most recent position in the episode. Set if the supplied access token is a user token and has the scope SpotifyScope.USER_READ_PLAYBACK_POSITION.

type

The object type: "episode".

Constructors

SimpleEpisode
Link copied to clipboard
common
fun SimpleEpisode(audioPreviewUrl: String? = null, description: String? = null, durationMs: Int, explicit: Boolean, externalUrlsString: Map<String, String>, href: String, id: String, images: List<SpotifyImage>, isExternallyHosted: Boolean, isPlayable: Boolean, language: String? = null, showLanguagesPrivate: List<String>, name: String, releaseDateString: String, releaseDatePrecisionString: String, resumePoint: ResumePoint? = null, type: String, uri: SpotifyUri)
A URL to a 30 second preview (MP3 format) of the episode.

Functions

getMembersThatNeedApiInstantiation
Link copied to clipboard
common
open override fun getMembersThatNeedApiInstantiation(): List<NeedsApi?>
toFullEpisode
Link copied to clipboard
common
suspend fun toFullEpisode(market: Market): Episode?
Converts this SimpleEpisode into a full Episode object
toFullEpisodeRestAction
Link copied to clipboard
common
fun toFullEpisodeRestAction(market: Market): SpotifyRestAction<Episode?>
Converts this SimpleEpisode into a full Episode object

Properties

api
Link copied to clipboard
common
lateinit var api: GenericSpotifyApi
The API client associated with the request
audioPreviewUrl
Link copied to clipboard
common
val audioPreviewUrl: String? = null
A URL to a 30 second preview (MP3 format) of the episode.
description
Link copied to clipboard
common
val description: String? = null
A description of the episode.
durationMs
Link copied to clipboard
common
val durationMs: Int
The episode length in milliseconds.
explicit
Link copied to clipboard
common
val explicit: Boolean
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
externalUrls
Link copied to clipboard
common
val externalUrls: List<ExternalUrl>
Known external URLs for this object
href
Link copied to clipboard
common
open override val href: String
A link to the Spotify web api endpoint associated with this request
id
Link copied to clipboard
common
open override val id: String
The Spotify id of the associated object
images
Link copied to clipboard
common
val images: List<SpotifyImage>
The cover art for the episode in various sizes, widest first.
isExternallyHosted
Link copied to clipboard
common
val isExternallyHosted: Boolean
True if the episode is hosted outside of Spotify’s CDN.
isPlayable
Link copied to clipboard
common
val isPlayable: Boolean
True if the episode is playable in the given market.
languages
Link copied to clipboard
common
val languages: List<Locale>
A list of the languages used in the episode, identified by their ISO 639 code.
name
Link copied to clipboard
common
val name: String
The name of the episode.
releaseDate
Link copied to clipboard
common
val releaseDate: ReleaseDate
The date the episode was first released, for example "1981-12-15".
releaseDatePrecisionString
Link copied to clipboard
common
val releaseDatePrecisionString: String
The precision with which release_date value is known: "year", "month", or "day".
resumePoint
Link copied to clipboard
common
val resumePoint: ResumePoint? = null
The user’s most recent position in the episode.
type
Link copied to clipboard
common
val type: String
The object type: "episode".
uri
Link copied to clipboard
common
open override val uri: SpotifyUri
The URI associated with the object

Sources

common source
Link copied to clipboard