Class: Spotted::Models::Me::Player::QueueGetResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Spotted::Models::Me::Player::QueueGetResponse

Defined in:

lib/spotted/models/me/player/queue_get_response.rb

Overview

See Also:

• Resources::Me::Player::Queue#get

Defined Under Namespace

Modules: CurrentlyPlaying, Queue

Instance Attribute Summary

• #currently_playing ⇒ Spotted::Models::TrackObject, ...

  The currently playing track or episode.

• #published ⇒ Boolean^?

  The playlist’s public/private status (if it should be added to the user’s profile or not): ‘true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant.

• #queue ⇒ Array<Spotted::Models::TrackObject, Spotted::Models::EpisodeObject>^?

  The tracks or episodes in the queue.

Class Method Summary

• .variants ⇒ Array(Spotted::Models::TrackObject, Spotted::Models::EpisodeObject)

Instance Method Summary

• #initialize(currently_playing: nil, published: nil, queue: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see QueueGetResponse for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(currently_playing: nil, published: nil, queue: nil) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::Me::Player::QueueGetResponse for more details.

Parameters:

• currently_playing (Spotted::Models::TrackObject, Spotted::Models::EpisodeObject) (defaults to: nil) —

  The currently playing track or episode. Can be ‘null`.

• published (Boolean) (defaults to: nil) —

  The playlist’s public/private status (if it should be added to the user’s profil

• queue (Array<Spotted::Models::TrackObject, Spotted::Models::EpisodeObject>) (defaults to: nil) —

  The tracks or episodes in the queue. Can be empty.

# File 'lib/spotted/models/me/player/queue_get_response.rb', line 32

Instance Attribute Details

#currently_playing ⇒ Spotted::Models::TrackObject, ...

The currently playing track or episode. Can be ‘null`.

Returns:

• (Spotted::Models::TrackObject, Spotted::Models::EpisodeObject, nil)

# File 'lib/spotted/models/me/player/queue_get_response.rb', line 13

optional :currently_playing, union: -> { Spotted::Models::Me::Player::QueueGetResponse::CurrentlyPlaying }

#published ⇒ Boolean^?

The playlist’s public/private status (if it should be added to the user’s profile or not): ‘true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)

Returns:

• (Boolean, nil)

# File 'lib/spotted/models/me/player/queue_get_response.rb', line 23

optional :published, Spotted::Internal::Type::Boolean

#queue ⇒ Array<Spotted::Models::TrackObject, Spotted::Models::EpisodeObject>^?

The tracks or episodes in the queue. Can be empty.

Returns:

• (Array<Spotted::Models::TrackObject, Spotted::Models::EpisodeObject>, nil)

# File 'lib/spotted/models/me/player/queue_get_response.rb', line 29

optional :queue,
-> { Spotted::Internal::Type::ArrayOf[union: Spotted::Models::Me::Player::QueueGetResponse::Queue] }

Class Method Details

.variants ⇒ Array(Spotted::Models::TrackObject, Spotted::Models::EpisodeObject)

Returns:

• (Array(Spotted::Models::TrackObject, Spotted::Models::EpisodeObject))

# File 'lib/spotted/models/me/player/queue_get_response.rb', line 54