Class Chapter

java.lang.Object
se.michaelthelin.spotify.model_objects.AbstractModelObject
se.michaelthelin.spotify.model_objects.specification.Chapter
All Implemented Interfaces:
Serializable, IModelObject
public class Chapter extends AbstractModelObject
Retrieve information about Chapter 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 chapter. null if not available.
      Returns:
      A URL to an audio preview.

    • getAvailableMarkets

      public String[] getAvailableMarkets()
      Get a list of the countries in which the chapter can be played.
      Returns:
      An array of ISO 3166-1 alpha-2 country codes.

    • getChapterNumber

      public Integer getChapterNumber()
      Get the number of the chapter.
      Returns:
      The number of the chapter.

    • getDescription

      public String getDescription()
      Get a description of the chapter. HTML tags are stripped away from this field.
      Returns:
      The description of the chapter.

    • getHtmlDescription

      public String getHtmlDescription()
      Get a description of the chapter. This field may contain HTML tags.
      Returns:
      The HTML description of the chapter.

    • getDurationMs

      public Integer getDurationMs()
      Get the duration of the chapter in milliseconds.
      Returns:
      The chapter length in milliseconds.

    • getExplicit

      public Boolean getExplicit()
      Check whether the chapter is explicit or not.
      Returns:
      Whether or not the chapter has explicit content.

    • getExternalUrls

      public ExternalUrl getExternalUrls()
      Get the external URLs of the chapter.
      Returns:
      An ExternalUrl object.

    • getHref

      public String getHref()
      Get the full Spotify Web API endpoint URL of the chapter.
      Returns:
      A link to the Web API endpoint providing full details of the chapter.

    • getId

      public String getId()
      Get the Spotify ID of the chapter.
      Returns:
      A Spotify chapter ID.

    • getImages

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

    • getPlayable

      public Boolean getPlayable()
      Check whether the chapter is playable in the given market.
      Returns:
      True if the chapter is playable in the given market. Otherwise false.

    • getLanguages

      public String[] getLanguages()
      Get a list of the languages used in the chapter.
      Returns:
      An array of ISO 639 language codes.

    • getName

      public String getName()
      Get the name of the chapter.
      Returns:
      The name of the chapter.

    • getReleaseDate

      public String getReleaseDate()
      Get the release date of the chapter.
      Returns:
      The date the chapter was first released.

    • getReleaseDatePrecision

      public ReleaseDatePrecision getReleaseDatePrecision()
      Get the precision of the release date.
      Returns:
      The precision with which release_date value is known.

    • getResumePoint

      public ResumePoint getResumePoint()
      Get the user's most recent position in the chapter.
      Returns:
      A ResumePoint object.

    • getType

      public ModelObjectType getType()
      Get the model object type. In this case "episode".
      Returns:
      A ModelObjectType.

    • getUri

      public String getUri()
      Get the Spotify URI of the chapter.
      Returns:
      Spotify chapter URI.

    • getRestrictions

      public ChapterRestriction getRestrictions()
      Get the content restriction applied, if any.
      Returns:
      A ChapterRestriction object, or null.

    • getAudiobook

      public AudiobookSimplified getAudiobook()
      Get the audiobook for which the chapter belongs.
      Returns:
      A AudiobookSimplified object.

    • 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 Chapter.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.
      Returns:
      A builder object.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object