Class: AsposePdfCloud::SoundAnnotation

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/sound_annotation.rb

Overview

Provides SoundAnnotation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SoundAnnotation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 153

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?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

  if attributes.has_key?(:'Color')
    self.color = attributes[:'Color']
  end

  if attributes.has_key?(:'Contents')
    self.contents = attributes[:'Contents']
  end

  if attributes.has_key?(:'Modified')
    self.modified = attributes[:'Modified']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.has_key?(:'Flags')
    if (value = attributes[:'Flags']).is_a?(Array)
      self.flags = value
    end
  end

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'Rect')
    self.rect = attributes[:'Rect']
  end

  if attributes.has_key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.has_key?(:'ZIndex')
    self.z_index = attributes[:'ZIndex']
  end

  if attributes.has_key?(:'HorizontalAlignment')
    self.horizontal_alignment = attributes[:'HorizontalAlignment']
  end

  if attributes.has_key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.has_key?(:'CreationDate')
    self.creation_date = attributes[:'CreationDate']
  end

  if attributes.has_key?(:'Subject')
    self.subject = attributes[:'Subject']
  end

  if attributes.has_key?(:'Title')
    self.title = attributes[:'Title']
  end

  if attributes.has_key?(:'RichText')
    self.rich_text = attributes[:'RichText']
  end

  if attributes.has_key?(:'FilePath')
    self.file_path = attributes[:'FilePath']
  end

  if attributes.has_key?(:'Icon')
    self.icon = attributes[:'Icon']
  end

  if attributes.has_key?(:'Rate')
    self.rate = attributes[:'Rate']
  end

  if attributes.has_key?(:'Channels')
    self.channels = attributes[:'Channels']
  end

  if attributes.has_key?(:'Bits')
    self.bits = attributes[:'Bits']
  end

  if attributes.has_key?(:'Encoding')
    self.encoding = attributes[:'Encoding']
  end

end

Instance Attribute Details

#bits ⇒ Object

Gets or sets the number of bits per sample value per channel.



89
90
91
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 89

def bits
  @bits
end

#channels ⇒ Object

Gets or sets the number of sound channels.



86
87
88
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 86

def channels
  @channels
end

#color ⇒ Object

Color of the annotation.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 32

def color
  @color
end

#contents ⇒ Object

Get the annotation content.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 35

def contents
  @contents
end

#creation_date ⇒ Object

The date and time when the annotation was created.



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 65

def creation_date
  @creation_date
end

#encoding ⇒ Object

Gets or sets the encoding format for the sample data.



92
93
94
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 92

def encoding
  @encoding
end

#file_path ⇒ Object

A sound file path defining the sound to be played when the annotation is activated.



77
78
79
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 77

def file_path
  @file_path
end

#flags ⇒ Object

Gets Flags of the annotation.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 44

def flags
  @flags
end

#horizontal_alignment ⇒ Object

Gets HorizontalAlignment of the annotation.



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 59

def horizontal_alignment
  @horizontal_alignment
end

#icon ⇒ Object

Gets or sets an icon to be used in displaying the annotation.



80
81
82
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 80

def icon
  @icon
end

#id ⇒ Object

Gets ID of the annotation.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 41

def id
  @id
end

#links ⇒ Object

Link to the document.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 29

def links
  @links
end

#modified ⇒ Object

The date and time when the annotation was last modified.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 38

def modified
  @modified
end

#name ⇒ Object

Gets Name of the annotation.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 47

def name
  @name
end

#page_index ⇒ Object

Gets PageIndex of the annotation.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 53

def page_index
  @page_index
end

#rate ⇒ Object

Gets or sets the sampling rate, in samples per second.



83
84
85
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 83

def rate
  @rate
end

#rect ⇒ Object

Gets Rect of the annotation.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 50

def rect
  @rect
end

#rich_text ⇒ Object

Get the annotation RichText.



74
75
76
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 74

def rich_text
  @rich_text
end

#subject ⇒ Object

Get the annotation subject.



68
69
70
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 68

def subject
  @subject
end

#title ⇒ Object

Get the annotation title.



71
72
73
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 71

def title
  @title
end

#vertical_alignment ⇒ Object

Gets VerticalAlignment of the annotation.



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 62

def vertical_alignment
  @vertical_alignment
end

#z_index ⇒ Object

Gets ZIndex of the annotation.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 56

def z_index
  @z_index
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 96

def self.attribute_map
  {
    :'links' => :'Links',
    :'color' => :'Color',
    :'contents' => :'Contents',
    :'modified' => :'Modified',
    :'id' => :'Id',
    :'flags' => :'Flags',
    :'name' => :'Name',
    :'rect' => :'Rect',
    :'page_index' => :'PageIndex',
    :'z_index' => :'ZIndex',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'creation_date' => :'CreationDate',
    :'subject' => :'Subject',
    :'title' => :'Title',
    :'rich_text' => :'RichText',
    :'file_path' => :'FilePath',
    :'icon' => :'Icon',
    :'rate' => :'Rate',
    :'channels' => :'Channels',
    :'bits' => :'Bits',
    :'encoding' => :'Encoding'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 124

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'color' => :'Color',
    :'contents' => :'String',
    :'modified' => :'String',
    :'id' => :'String',
    :'flags' => :'Array<AnnotationFlags>',
    :'name' => :'String',
    :'rect' => :'Rectangle',
    :'page_index' => :'Integer',
    :'z_index' => :'Integer',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'creation_date' => :'String',
    :'subject' => :'String',
    :'title' => :'String',
    :'rich_text' => :'String',
    :'file_path' => :'String',
    :'icon' => :'SoundIcon',
    :'rate' => :'Integer',
    :'channels' => :'Integer',
    :'bits' => :'Integer',
    :'encoding' => :'SoundEncoding'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      color == o.color &&
      contents == o.contents &&
      modified == o.modified &&
      id == o.id &&
      flags == o.flags &&
      name == o.name &&
      rect == o.rect &&
      page_index == o.page_index &&
      z_index == o.z_index &&
      horizontal_alignment == o.horizontal_alignment &&
      vertical_alignment == o.vertical_alignment &&
      creation_date == o.creation_date &&
      subject == o.subject &&
      title == o.title &&
      rich_text == o.rich_text &&
      file_path == o.file_path &&
      icon == o.icon &&
      rate == o.rate &&
      channels == o.channels &&
      bits == o.bits &&
      encoding == o.encoding
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 360

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 = AsposePdfCloud.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 426

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 339

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


326
327
328
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



332
333
334
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 332

def hash
  [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, file_path, icon, rate, channels, bits, encoding].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 255

def list_invalid_properties
  invalid_properties = Array.new
  if @rect.nil?
    invalid_properties.push("invalid value for 'rect', rect cannot be nil.")
  end

  if @file_path.nil?
    invalid_properties.push("invalid value for 'file_path', file_path cannot be nil.")
  end

  if @file_path.to_s.length < 1
    invalid_properties.push("invalid value for 'file_path', the character length must be great than or equal to 1.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



406
407
408
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 406

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



412
413
414
415
416
417
418
419
420
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 412

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

Returns:

  • (String) —

    String presentation of the object



400
401
402
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 400

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



274
275
276
277
278
279
 
# File 'lib/aspose_pdf_cloud/models/sound_annotation.rb', line 274

def valid?
  return false if @rect.nil?
  return false if @file_path.nil?
  return false if @file_path.to_s.length < 1
  return true
end