Package se.michaelthelin.spotify.model_objects.specification

Class Playlist

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

  • Method Details

    • getIsCollaborative

      public Boolean getIsCollaborative()
      Check whether the playlist is collaborative or not.
      Returns:
      true if the owner allows other users to modify the playlist, false if not.
      See Also:

    • getDescription

      public String getDescription()
      Get the description of the playlist.
      Returns:
      The playlist description. Only returned for modified, verified playlists, otherwise null.

    • getExternalUrls

      public ExternalUrl getExternalUrls()
      Get the external URLs of the playlist.
      Example: Spotify-URL.
      Returns:
      Known external URLs for this playlist.

    • getFollowers

      public Followers getFollowers()
      Get information about the followers of the playlist.
      Example: Follower count.
      Returns:
      Information about the followers of the playlist.

    • getHref

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

    • getId

      public String getId()
      Get the Spotify ID of a playlist.
      Returns:
      The Spotify ID for the playlist.

    • getImages

      public Image[] getImages()
      Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order.
      Note: If returned, the source URL for the image is temporary and will expire in less than a day.
      Returns:
      An array of images in different sizes.
      See Also:

    • getName

      public String getName()
      Get the name of a playlist.
      Returns:
      Playlist name.

    • getOwner

      public User getOwner()
      Get the owners user object of a playlist.
      Returns:
      A user object.

    • getIsPublicAccess

      public Boolean getIsPublicAccess()
      Check whether a playlist is available in public or is private.
      Returns:
      true the playlist is public, false the playlist is private, null the playlist status is not relevant.
      See Also:

    • getSnapshotId

      public String getSnapshotId()
      Get the snapshot ID, the version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version.
      Returns:
      The version identifier for the current playlist.
      See Also:

    • getTracks

      public Paging<PlaylistTrack> getTracks()
      Get information about the tracks of the playlist.
      Returns:
      Information about the tracks of the playlist.

    • getType

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

    • getUri

      public String getUri()
      Get the Spotify URI of a playlist.
      Returns:
      Spotify playlist 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 Playlist.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