Class: FlatApi::ScoreCreation
- Inherits:
-
Object
- Object
- FlatApi::ScoreCreation
- Defined in:
- lib/flat_api/models/score_creation.rb
Overview
A new created score
Instance Attribute Summary collapse
-
#collection ⇒ Object
Unique identifier of a collection where the score will be created.
-
#data ⇒ Object
Returns the value of attribute data.
-
#data_encoding ⇒ Object
Returns the value of attribute data_encoding.
-
#google_drive_folder ⇒ Object
If the user uses Google Drive and this properties is specified, the file will be created in this directory.
-
#privacy ⇒ Object
Returns the value of attribute privacy.
-
#source ⇒ Object
Returns the value of attribute source.
-
#title ⇒ Object
The title of the new score.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ScoreCreation
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ScoreCreation
Initializes the object
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/flat_api/models/score_creation.rb', line 64 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'privacy') self.privacy = attributes[:'privacy'] end if attributes.has_key?(:'data') self.data = attributes[:'data'] end if attributes.has_key?(:'dataEncoding') self.data_encoding = attributes[:'dataEncoding'] end if attributes.has_key?(:'source') self.source = attributes[:'source'] end if attributes.has_key?(:'collection') self.collection = attributes[:'collection'] end if attributes.has_key?(:'googleDriveFolder') self.google_drive_folder = attributes[:'googleDriveFolder'] end end |
Instance Attribute Details
#collection ⇒ Object
Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the ‘root` directory.
30 31 32 |
# File 'lib/flat_api/models/score_creation.rb', line 30 def collection @collection end |
#data ⇒ Object
Returns the value of attribute data.
23 24 25 |
# File 'lib/flat_api/models/score_creation.rb', line 23 def data @data end |
#data_encoding ⇒ Object
Returns the value of attribute data_encoding.
25 26 27 |
# File 'lib/flat_api/models/score_creation.rb', line 25 def data_encoding @data_encoding end |
#google_drive_folder ⇒ Object
If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.
33 34 35 |
# File 'lib/flat_api/models/score_creation.rb', line 33 def google_drive_folder @google_drive_folder end |
#privacy ⇒ Object
Returns the value of attribute privacy.
21 22 23 |
# File 'lib/flat_api/models/score_creation.rb', line 21 def privacy @privacy end |
#source ⇒ Object
Returns the value of attribute source.
27 28 29 |
# File 'lib/flat_api/models/score_creation.rb', line 27 def source @source end |
#title ⇒ Object
The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified ‘source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](www.musicxml.com/) files). - Set a default title (e.g. "New Music Score")
19 20 21 |
# File 'lib/flat_api/models/score_creation.rb', line 19 def title @title end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/flat_api/models/score_creation.rb', line 37 def self.attribute_map { :'title' => :'title', :'privacy' => :'privacy', :'data' => :'data', :'data_encoding' => :'dataEncoding', :'source' => :'source', :'collection' => :'collection', :'google_drive_folder' => :'googleDriveFolder' } end |
.swagger_types ⇒ Object
Attribute type mapping.
50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/flat_api/models/score_creation.rb', line 50 def self.swagger_types { :'title' => :'String', :'privacy' => :'ScorePrivacy', :'data' => :'ScoreData', :'data_encoding' => :'ScoreDataEncoding', :'source' => :'ScoreSource', :'collection' => :'String', :'google_drive_folder' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/flat_api/models/score_creation.rb', line 120 def ==(o) return true if self.equal?(o) self.class == o.class && title == o.title && privacy == o.privacy && data == o.data && data_encoding == o.data_encoding && source == o.source && collection == o.collection && google_drive_folder == o.google_drive_folder end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/flat_api/models/score_creation.rb', line 168 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = FlatApi.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/flat_api/models/score_creation.rb', line 234 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/flat_api/models/score_creation.rb', line 147 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
134 135 136 |
# File 'lib/flat_api/models/score_creation.rb', line 134 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
140 141 142 |
# File 'lib/flat_api/models/score_creation.rb', line 140 def hash [title, privacy, data, data_encoding, source, collection, google_drive_folder].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
102 103 104 105 106 107 108 109 |
# File 'lib/flat_api/models/score_creation.rb', line 102 def list_invalid_properties invalid_properties = Array.new if @privacy.nil? invalid_properties.push("invalid value for 'privacy', privacy cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
214 215 216 |
# File 'lib/flat_api/models/score_creation.rb', line 214 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
220 221 222 223 224 225 226 227 228 |
# File 'lib/flat_api/models/score_creation.rb', line 220 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
208 209 210 |
# File 'lib/flat_api/models/score_creation.rb', line 208 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
113 114 115 116 |
# File 'lib/flat_api/models/score_creation.rb', line 113 def valid? return false if @privacy.nil? return true end |