Class: SpotifyWebApi::ManyAlbums

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

Overview

ManyAlbums Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(albums = nil) ⇒ ManyAlbums

Returns a new instance of ManyAlbums.



33
34
35
 
# File 'lib/spotify_web_api/models/many_albums.rb', line 33

def initialize(albums = nil)
  @albums = albums
end

Instance Attribute Details

#albums ⇒ Array[AlbumObject]

TODO: Write general description for this method

Returns:



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

def albums
  @albums
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/spotify_web_api/models/many_albums.rb', line 38

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  albums = nil
  unless hash['albums'].nil?
    albums = []
    hash['albums'].each do |structure|
      albums << (AlbumObject.from_hash(structure) if structure)
    end
  end

  albums = nil unless hash.key?('albums')

  # Create object from extracted values.
  ManyAlbums.new(albums)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/spotify_web_api/models/many_albums.rb', line 17

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

.nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/spotify_web_api/models/many_albums.rb', line 29

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/spotify_web_api/models/many_albums.rb', line 24

def self.optionals
  []
end