Class: SpotifyWebApi::QueueObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/spotify_web_api/models/queue_object.rb

Overview

QueueObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(currently_playing = SKIP, queue = SKIP) ⇒ QueueObject

Returns a new instance of QueueObject.



41
42
43
44
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 41

def initialize(currently_playing = SKIP, queue = SKIP)
  @currently_playing = currently_playing unless currently_playing == SKIP
  @queue = queue unless queue == SKIP
end

Instance Attribute Details

#currently_playing ⇒ Object

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

Returns:

  • (Object) 


14
15
16
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 14

def currently_playing
  @currently_playing
end

#queue ⇒ Array[Object]

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

Returns:

  • (Array[Object]) 


18
19
20
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 18

def queue
  @queue
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  currently_playing =
    hash.key?('currently_playing') ? hash['currently_playing'] : SKIP
  queue = hash.key?('queue') ? hash['queue'] : SKIP

  # Create object from extracted values.
  QueueObject.new(currently_playing,
                  queue)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['currently_playing'] = 'currently_playing'
  @_hash['queue'] = 'queue'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/spotify_web_api/models/queue_object.rb', line 29

def self.optionals
  %w[
    currently_playing
    queue
  ]
end