Burgestrand/spotify

View on GitHub
lib/spotify/api/artist.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Spotify
  class API
    # @!group Artist

    # @see #artist_is_loaded
    # @note the artist must be loaded, or this function always return an empty string.
    # @param [Artist] artist
    # @return [String] name of the artist
    # @method artist_name(artist)
    attach_function :artist_name, [ Artist ], UTF8String

    # @param [Artist] artist
    # @return [Boolean] true if the artist is populated with data
    # @method artist_is_loaded(artist)
    attach_function :artist_is_loaded, [ Artist ], :bool

    # @see #image_create
    # @see #artist_is_loaded
    # @note the artist must be loaded, or this function always return nil.
    # @param [Artist] artist
    # @param [Symbol] image_size one of :normal, :small, :large
    # @return [String, nil] image ID to pass to {#image_create}, or nil if the artist has no image
    # @method artist_portrait(artist, image_size)
    attach_function :artist_portrait, [ Artist, :image_size ], ImageID

    attach_function :artist_add_ref, [ Artist ], APIError
    attach_function :artist_release, [ Artist ], APIError
  end
end