Interface IEpisode
- All Superinterfaces:
IModelObject,IPlaylistItem,Serializable
- All Known Implementing Classes:
Episode,EpisodeSimplified
Represents the common properties of Spotify Episode objects (full and simplified).
This interface extends IPlaylistItem and provides a common base for
Episode and
EpisodeSimplified
objects.
-
Nested Class Summary
Nested classes/interfaces inherited from interface se.michaelthelin.spotify.model_objects.IModelObject
IModelObject.Builder, IModelObject.IJsonUtil<T> -
Method Summary
Modifier and TypeMethodDescriptionGet a link to a 30 second preview (MP3 format) of the episode.Get a description of the episode.Check whether the episode is explicit or not.Check whether the episode is hosted outside of Spotify's CDN.Image[]Get the cover art for the episode in various sizes, widest first.String[]Get a list of the languages used in the episode, identified by their ISO 639 code.Check whether the episode is playable in the given market.Get the date the episode was first released, for example "1981-12-15".Get the precision with which the release date is known.Get the user's most recent position in the episode.Methods inherited from interface se.michaelthelin.spotify.model_objects.IModelObject
builderMethods inherited from interface se.michaelthelin.spotify.model_objects.IPlaylistItem
getDurationMs, getExternalUrls, getHref, getId, getName, getType, getUri
-
Method Details
-
getAudioPreviewUrl
String getAudioPreviewUrl()Get a link to a 30 second preview (MP3 format) of the episode.nullif not available.- Returns:
- A link to a 30 second preview (MP3 format) of the episode.
nullif not available.
-
getDescription
String getDescription()Get a description of the episode.- Returns:
- The description of the episode.
-
getExplicit
Boolean getExplicit()Check whether the episode is explicit or not.- Returns:
- Whether or not the episode has explicit content (
true= yes it does;false= no it does not OR unknown).
-
getImages
Image[] getImages()Get the cover art for the episode in various sizes, widest first.- Returns:
- An array of
Imageobjects.
-
getExternallyHosted
Boolean getExternallyHosted()Check whether the episode is hosted outside of Spotify's CDN.- Returns:
- True if the episode is hosted outside of Spotify's CDN.
-
getPlayable
Boolean getPlayable()Check whether the episode is playable in the given market.- Returns:
- True if the episode is playable in the given market. Otherwise false.
-
getLanguages
String[] getLanguages()Get a list of the languages used in the episode, identified by their ISO 639 code.- Returns:
- An array of ISO 3166-1 alpha-2 country codes.
-
getReleaseDate
String getReleaseDate()Get the date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".- Returns:
- The release date of the episode.
-
getReleaseDatePrecision
ReleaseDatePrecision getReleaseDatePrecision()Get the precision with which the release date is known.- Returns:
- A
ReleaseDatePrecisionobject.
-
getResumePoint
ResumePoint getResumePoint()Get the user's most recent position in the episode. Set if the supplied access token is a user token and has the scopeuser-read-playback-position.- Returns:
- A
ResumePointobject.
-