Net-Async-Spotify/lib/Net/Async/Spotify/Object/Generated/Episode.pod
=encoding utf8
=for comment POD_DERIVED_INDEX_GENERATED
The following documentation is automatically generated. Please do not edit
this file, but rather the original, inline with Net::Async::Spotify::Object::Generated::Episode
at lib/Net/Async/Spotify/Object/Generated/Episode.pm
(on the system that originally ran this).
If you do edit this file, and don't want your changes to be removed, make
sure you change the first line.
=cut
=head1 NAME
Net::Async::Spotify::Object::Generated::Episode - Package representing Spotify Episode Object
=head1 DESCRIPTION
Autogenerated module.
Based on https://developer.spotify.com/documentation/web-api/reference/#objects-index
Check C<crawl-api-doc.pl> for more information.
=head1 PARAMETERS
Those are Spotify Episode Object attributes:
=over 4
=item audio_preview_url
Type:String
Description:A URL to a 30 second preview (MP3 format) of the episode. null if not available.
=item description
Type:String
Description:A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
=item duration_ms
Type:Integer
Description:The episode length in milliseconds.
=item explicit
Type:Boolean
Description:Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
=item external_urls
Type:ExternalUrlObject
Description:External URLs for this episode.
=item href
Type:String
Description:A link to the Web API endpoint providing full details of the episode.
=item html_description
Type:String
Description:A description of the episode. This field may contain HTML tags.
=item id
Type:String
Description:The Spotify ID for the episode.
=item images
Type:Array[ImageObject]
Description:The cover art for the episode in various sizes, widest first.
=item is_externally_hosted
Type:Boolean
Description:True if the episode is hosted outside of Spotify’s CDN.
=item is_playable
Type:Boolean
Description:True if the episode is playable in the given market. Otherwise false.
=item language
Type:String
Description:Note: This field is deprecated and might be removed in the future. Please use the languages field instead. The language used in the episode, identified by a ISO 639 code.
=item languages
Type:Array[String]
Description:A list of the languages used in the episode, identified by their ISO 639 code.
=item name
Type:String
Description:The name of the episode.
=item release_date
Type:String
Description: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".
=item release_date_precision
Type:String
Description:The precision with which release_date value is known: "year", "month", or "day".
=item restrictions
Type:EpisodeRestrictionObject
Description:Included in the response when a content restriction is applied.
See Restriction Object for more details.
=item resume_point
Type:ResumePointObject
Description: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.
=item show
Type:SimplifiedShowObject
Description:The show on which the episode belongs.
=item type
Type:String
Description:The object type: “episode”.
=item uri
Type:String
Description:The Spotify URI for the episode.
=back
=head1 INHERITED METHODS
=over 4
=item L<Net::Async::Spotify::Object::Base>
L<apply_type|Net::Async::Spotify::Object::Base/apply_type>, L<extra_fields|Net::Async::Spotify::Object::Base/extra_fields>, L<fields|Net::Async::Spotify::Object::Base/fields>, L<generate|Net::Async::Spotify::Object::Base/generate>, L<to_hash|Net::Async::Spotify::Object::Base/to_hash>, L<to_human|Net::Async::Spotify::Object::Base/to_human>, L<to_json|Net::Async::Spotify::Object::Base/to_json>
=back