Class: AppleMusic::Playlist::Attributes

Inherits:
Object
  • Object
show all
Defined in:
lib/apple_music/playlist/attributes.rb

Overview

developer.apple.com/documentation/applemusicapi/playlist/attributes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props = {}) ⇒ Attributes

Returns a new instance of Attributes.



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/apple_music/playlist/attributes.rb', line 10

def initialize(props = {})
  @artwork = Artwork.new(props['artwork']) if props['artwork']
  @curator_name = props['curatorName']
  @description = EditorialNotes.new(props['description']) if props['description']
  @last_modified_date = Date.parse(props['lastModifiedDate']) if props['lastModifiedDate']
  @name = props['name'] # required
  @play_params = PlayParameters.new(props['playParams']) if props['playParams']
  @playlist_type = props['playlistType'] # required
  @url = props['url'] # required
  @is_chart = props['isChart']
end

Instance Attribute Details

#artwork ⇒ Object (readonly)

Returns the value of attribute artwork.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def artwork
  @artwork
end

#curator_name ⇒ Object (readonly)

Returns the value of attribute curator_name.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def curator_name
  @curator_name
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def description
  @description
end

#is_chart ⇒ Object (readonly)

Returns the value of attribute is_chart.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def is_chart
  @is_chart
end

#last_modified_date ⇒ Object (readonly)

Returns the value of attribute last_modified_date.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def last_modified_date
  @last_modified_date
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def name
  @name
end

#play_params ⇒ Object (readonly)

Returns the value of attribute play_params.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def play_params
  @play_params
end

#playlist_type ⇒ Object (readonly)

Returns the value of attribute playlist_type.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def playlist_type
  @playlist_type
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



7
8
9
 
# File 'lib/apple_music/playlist/attributes.rb', line 7

def url
  @url
end

Instance Method Details

#chart? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/apple_music/playlist/attributes.rb', line 22

def chart?
  is_chart
end

#editorial? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/apple_music/playlist/attributes.rb', line 30

def editorial?
  playlist_type == 'editorial'
end

#external? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/apple_music/playlist/attributes.rb', line 34

def external?
  playlist_type == 'external'
end

#personal_mix? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/apple_music/playlist/attributes.rb', line 38

def personal_mix?
  playlist_type == 'personal-mix'
end

#user_shared? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/apple_music/playlist/attributes.rb', line 26

def user_shared?
  playlist_type == 'user-shared'
end