Package se.michaelthelin.spotify.model_objects.specification

Class Episode

java.lang.Object
se.michaelthelin.spotify.model_objects.AbstractModelObject
se.michaelthelin.spotify.model_objects.specification.Episode
All Implemented Interfaces:
Serializable, IModelObject, IPlaylistItem
public class Episode extends AbstractModelObject implements IPlaylistItem
Retrieve information about episode objects by building instances from this class.
See Also:

  • Method Details

    • getAudioPreviewUrl

      public String getAudioPreviewUrl()
      Get a URL to a 30 second preview (MP3 format) of the episode. null if not available.
      Returns:
      A URL to an audio preview.

    • getDescription

      public String getDescription()
      Get a description of the episode.
      Returns:
      The description of the episode.

    • getDurationMs

      public Integer getDurationMs()
      Get the duration of the episode in milliseconds.
      Specified by:
      getDurationMs in interface IPlaylistItem
      Returns:
      The length of the episode in milliseconds.

    • getExplicit

      public 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).

    • getExternalUrls

      public ExternalUrl getExternalUrls()
      Get the external URLs of the episode.
      Example: Spotify-URL
      Specified by:
      getExternalUrls in interface IPlaylistItem
      Returns:
      An ExternalUrl object.

    • getHref

      public String getHref()
      Get the full Spotify Web API endpoint URL of the episode.
      Specified by:
      getHref in interface IPlaylistItem
      Returns:
      A link to the Web API endpoint providing full details of the episode.

    • getId

      public String getId()
      Get the Spotify ID of the episode.
      Specified by:
      getId in interface IPlaylistItem
      Returns:
      A Spotify episode ID.

    • getImages

      public Image[] getImages()
      Get the cover art for the episode in various sizes, widest first.
      Returns:
      An array of Image objects.

    • getExternallyHosted

      public 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

      public 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

      public 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.

    • getName

      public String getName()
      Get the name of the episode.
      Specified by:
      getName in interface IPlaylistItem
      Returns:
      The name of the episode.

    • getReleaseDate

      public 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

      public ReleaseDatePrecision getReleaseDatePrecision()
      Get the precision with which the release date is known.
      Returns:
      A ReleaseDatePrecision object.

    • getResumePoint

      public 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 scope user-read-playback-position.
      Returns:
      A ResumePoint object.

    • getShow

      public ShowSimplified getShow()
      Get the show on which the episode belongs.
      Returns:
      A Show object on which the episode belongs.

    • getType

      public ModelObjectType getType()
      Get the model object type. In this case "episode".
      Specified by:
      getType in interface IPlaylistItem
      Returns:
      A ModelObjectType.

    • getUri

      public String getUri()
      Get the Spotify URI of the episode.
      Specified by:
      getUri in interface IPlaylistItem
      Returns:
      Spotify episode URI.

    • toString

      public String toString()
      Description copied from class: AbstractModelObject
      Returns a String representation of this model object in the style:

      ModelObject(attr1=value1, attr2=value2, ...)

      Specified by:
      toString in class AbstractModelObject

    • builder

      public Episode.Builder builder()
      Description copied from interface: IModelObject
      Create a builder for building an instance of a model object.
      The type of the builder and its methods depend on its corresponding implementation.
      Specified by:
      builder in interface IModelObject
      Returns:
      A builder object.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object