se.michaelthelin.spotify.model_objects.IPlaylistItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotify-web-api-java Show documentation

A Java client for Spotify's Web API

There is a newer version: 9.0.0-RC1

package se.michaelthelin.spotify.model_objects;

import se.michaelthelin.spotify.enums.ModelObjectType;
import se.michaelthelin.spotify.model_objects.specification.Episode;
import se.michaelthelin.spotify.model_objects.specification.ExternalUrl;
import se.michaelthelin.spotify.model_objects.specification.Track;


/**
 * This interface represents objects returned by the API that can be played, saved in a playlist, etc,
 * currently {@link Episode} and {@link Track}.
 */
public interface IPlaylistItem extends IModelObject {

  /**
   * Get the duration of this playlist item in milliseconds.
   *
   * @return The playlist item length in milliseconds.
   */
  public Integer getDurationMs();

  /**
   * Get the external URLs of the playlist item.

   * Example: Spotify-URL.
   *
   * @return Known external URLs for this playlist item.
   */
  public ExternalUrl getExternalUrls();

  /**
   * Get the full Spotify Web API endpoint URL of the playlist item.
   *
   * @return A link to the Web API endpoint providing full details of the playlist item.
   */
  public String getHref();

  /**
   * Get the Spotify ID of the
   * playlist item.
   *
   * @return The Spotify ID for the playlist item.
   */
  public String getId();

  /**
   * Get the name of the playlist item.
   *
   * @return playlist item name.
   */
  public String getName();

  /**
   * Get the type of the IPlaylistItem.
   * Possible values: {@code ModelObjectType.TRACK} or {@code ModelObjectType.EPISODE}
   *
   * @return The type of the IPlaylistItem.
   */
  ModelObjectType getType();

  /**
   * Get the Spotify playlist item URI.
   *
   * @return The Spotify URI for
   * the playlist item.
   */
  public String getUri();
}