Class: WordsRubySdk::Footnote
- Inherits:
-
Object
- Object
- WordsRubySdk::Footnote
- Defined in:
- lib/words_ruby_sdk/models/footnote.rb
Overview
Footnote.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#content ⇒ Object
Content of footnote.
-
#footnote_type ⇒ Object
Returns a value that specifies whether this is a footnote or endnote.
-
#link ⇒ Object
Link to the document.
-
#node_id ⇒ Object
Node id.
-
#position ⇒ Object
Link to comment range start node.
-
#reference_mark ⇒ Object
Gets/sets custom reference mark to be used for this footnote.
-
#text ⇒ Object
This is a convenience property that allows to easily get or set text of the footnote.
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
-
#==(other) ⇒ 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?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Footnote
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 = {}) ⇒ Footnote
Initializes the object
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 105 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.key?(:'link') self.link = attributes[:'link'] end if attributes.key?(:'NodeId') self.node_id = attributes[:'NodeId'] end if attributes.key?(:'Content') self.content = attributes[:'Content'] end if attributes.key?(:'FootnoteType') self.footnote_type = attributes[:'FootnoteType'] end if attributes.key?(:'Position') self.position = attributes[:'Position'] end if attributes.key?(:'ReferenceMark') self.reference_mark = attributes[:'ReferenceMark'] end if attributes.key?(:'Text') self.text = attributes[:'Text'] end end |
Instance Attribute Details
#content ⇒ Object
Content of footnote.
41 42 43 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 41 def content @content end |
#footnote_type ⇒ Object
Returns a value that specifies whether this is a footnote or endnote.
44 45 46 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 44 def footnote_type @footnote_type end |
#link ⇒ Object
Link to the document.
35 36 37 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 35 def link @link end |
#node_id ⇒ Object
Node id
38 39 40 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 38 def node_id @node_id end |
#position ⇒ Object
Link to comment range start node.
47 48 49 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 47 def position @position end |
#reference_mark ⇒ Object
Gets/sets custom reference mark to be used for this footnote. Default value is , meaning auto-numbered footnotes are used.
50 51 52 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 50 def reference_mark @reference_mark end |
#text ⇒ Object
This is a convenience property that allows to easily get or set text of the footnote.
53 54 55 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 53 def text @text end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 78 def self.attribute_map { :'link' => :'link', :'node_id' => :'NodeId', :'content' => :'Content', :'footnote_type' => :'FootnoteType', :'position' => :'Position', :'reference_mark' => :'ReferenceMark', :'text' => :'Text' } end |
.swagger_types ⇒ Object
Attribute type mapping.
91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 91 def self.swagger_types { :'link' => :'WordsApiLink', :'node_id' => :'String', :'content' => :'StoryChildNodes', :'footnote_type' => :'String', :'position' => :'DocumentPosition', :'reference_mark' => :'String', :'text' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 172 def ==(other) return true if self.equal?(other) self.class == other.class && link == other.link && node_id == other.node_id && content == other.content && footnote_type == other.footnote_type && position == other.position && reference_mark == other.reference_mark && text == other.text end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 221 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date 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 = WordsRubySdk.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
288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 288 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
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 199 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?(other) ⇒ Boolean
186 187 188 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 186 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
192 193 194 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 192 def hash [link, node_id, content, footnote_type, position, reference_mark, text].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
143 144 145 146 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 143 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
268 269 270 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 268 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
274 275 276 277 278 279 280 281 282 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 274 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
262 263 264 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 262 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
150 151 152 153 154 |
# File 'lib/words_ruby_sdk/models/footnote.rb', line 150 def valid? footnote_type_validator = EnumAttributeValidator.new('String', %w["Footnote", "Endnote"]) return false unless footnote_type_validator.valid?(@footnote_type) return true end |