lib/rspotify/playlist.rb in rspotify-1.11.0 vs lib/rspotify/playlist.rb in rspotify-1.12.0
- old
+ new
@@ -1,11 +1,11 @@
module RSpotify
# @attr [Boolean] collaborative true if the owner allows other users to modify the playlist
# @attr [String] description The playlist description
# @attr [Hash] followers Information about the followers of the playlist
- # @attr [Array<Hash>] images The playlist images
+ # @attr [Array<Hash>] images Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. If returned, the source URL for the image is temporary and will expire in less than one day.
# @attr [String] name The name of the playlist
# @attr [User] owner The user who owns the playlist
# @attr [Boolean] public true if the playlist is not marked as secret
# @attr [String] snapshot_id The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
# @attr [Integer] total The total number of tracks in the playlist
@@ -15,11 +15,11 @@
# Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s “Browse” tab).
#
# @param limit [Integer] Maximum number of playlists to return. Maximum: 50. Default: 20.
# @param offset [Integer] The index of the first playlist to return. Use with limit to get the next set of playlists. Default: 0.
- # @param locale [String] Optional. The desired language, consisting of a lowercase {http://en.wikipedia.org/wiki/ISO_639 ISO 639 language code} and an uppercase {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}, joined by an underscore. For details access {https://developer.spotify.com/web-api/get-list-featured-playlists/ here} and look for the locale parameter description.
# @param country [String] Optional. A country: an {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Provide this parameter if you want the list of returned playlists to be relevant to a particular country. If omitted, the returned playlists will be relevant to all countries.
+ # @param locale [String] Optional. The desired language, consisting of a lowercase {http://en.wikipedia.org/wiki/ISO_639 ISO 639 language code} and an uppercase {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}, joined by an underscore. For details access {https://developer.spotify.com/web-api/get-list-featured-playlists/ here} and look for the locale parameter description.
# @param timestamp [String] Optional. A timestamp in {http://en.wikipedia.org/wiki/ISO_8601 ISO 8601} format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time. Example: "2014-10-23T09:00:00" for a user whose local time is 9AM.
# @return [Array<Playlist>]
#
# @example
# playlists = RSpotify::Playlist.browse_featured