Class: GroupDocsConversionCloud::PresentationLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/presentation_load_options.rb

Overview

Presentation document load options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PresentationLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 134

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?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'PreserveDocumentStructure')
    self.preserve_document_structure = attributes[:'PreserveDocumentStructure']
  end

  if attributes.key?(:'ClearCustomDocumentProperties')
    self.clear_custom_document_properties = attributes[:'ClearCustomDocumentProperties']
  end

  if attributes.key?(:'ClearBuiltInDocumentProperties')
    self.clear_built_in_document_properties = attributes[:'ClearBuiltInDocumentProperties']
  end

  if attributes.key?(:'Depth')
    self.depth = attributes[:'Depth']
  end

  if attributes.key?(:'ConvertOwned')
    self.convert_owned = attributes[:'ConvertOwned']
  end

  if attributes.key?(:'ConvertOwner')
    self.convert_owner = attributes[:'ConvertOwner']
  end

  if attributes.key?(:'ShowHiddenSlides')
    self.show_hidden_slides = attributes[:'ShowHiddenSlides']
  end

  if attributes.key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.key?(:'FontSubstitutes')
    if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
      self.font_substitutes = value
    end
  end

  if attributes.key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.key?(:'CommentsPosition')
    self.comments_position = attributes[:'CommentsPosition']
  end

  if attributes.key?(:'NotesPosition')
    self.notes_position = attributes[:'NotesPosition']
  end

end

Instance Attribute Details

#clear_built_in_document_properties ⇒ Object

Value indicating whether built in document properties should be cleared.



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 44

def clear_built_in_document_properties
  @clear_built_in_document_properties
end

#clear_custom_document_properties ⇒ Object

Value indicating whether custom document properties should be cleared.



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 41

def clear_custom_document_properties
  @clear_custom_document_properties
end

#comments_position ⇒ Object

Represents the way comments are printed with the slide. Default is None.



68
69
70
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 68

def comments_position
  @comments_position
end

#convert_owned ⇒ Object

Option to control whether the owned documents in the documents container must be converted



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 50

def convert_owned
  @convert_owned
end

#convert_owner ⇒ Object

Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document Default is true



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 53

def convert_owner
  @convert_owner
end

#default_font ⇒ Object

Default font for rendering the presentation. The following font will be used if a presentation font is missing.



59
60
61
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 59

def default_font
  @default_font
end

#depth ⇒ Object

Option to control how many levels in depth to perform conversion Default: 1



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 47

def depth
  @depth
end

#font_substitutes ⇒ Object

Substitute specific fonts when converting Slides document.



62
63
64
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 62

def font_substitutes
  @font_substitutes
end

#format ⇒ Object

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 35

def format
  @format
end

#notes_position ⇒ Object

Represents the way notes are printed with the slide. Default is None.



71
72
73
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 71

def notes_position
  @notes_position
end

#password ⇒ Object

Set password to unprotect protected document



65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 65

def password
  @password
end

#preserve_document_structure ⇒ Object

Determines whether the document structure should be preserved when converting to PDF (default is false).



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 38

def preserve_document_structure
  @preserve_document_structure
end

#show_hidden_slides ⇒ Object

Show hidden slides.



56
57
58
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 56

def show_hidden_slides
  @show_hidden_slides
end

Class Method Details

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 95

def self.attribute_map
  {
    :'format' => :'Format',
    :'preserve_document_structure' => :'PreserveDocumentStructure',
    :'clear_custom_document_properties' => :'ClearCustomDocumentProperties',
    :'clear_built_in_document_properties' => :'ClearBuiltInDocumentProperties',
    :'depth' => :'Depth',
    :'convert_owned' => :'ConvertOwned',
    :'convert_owner' => :'ConvertOwner',
    :'show_hidden_slides' => :'ShowHiddenSlides',
    :'default_font' => :'DefaultFont',
    :'font_substitutes' => :'FontSubstitutes',
    :'password' => :'Password',
    :'comments_position' => :'CommentsPosition',
    :'notes_position' => :'NotesPosition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 114

def self.swagger_types
  {
    :'format' => :'String',
    :'preserve_document_structure' => :'BOOLEAN',
    :'clear_custom_document_properties' => :'BOOLEAN',
    :'clear_built_in_document_properties' => :'BOOLEAN',
    :'depth' => :'Integer',
    :'convert_owned' => :'BOOLEAN',
    :'convert_owner' => :'BOOLEAN',
    :'show_hidden_slides' => :'BOOLEAN',
    :'default_font' => :'String',
    :'font_substitutes' => :'Hash<String, String>',
    :'password' => :'String',
    :'comments_position' => :'String',
    :'notes_position' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 288

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      preserve_document_structure == other.preserve_document_structure &&
      clear_custom_document_properties == other.clear_custom_document_properties &&
      clear_built_in_document_properties == other.clear_built_in_document_properties &&
      depth == other.depth &&
      convert_owned == other.convert_owned &&
      convert_owner == other.convert_owner &&
      show_hidden_slides == other.show_hidden_slides &&
      default_font == other.default_font &&
      font_substitutes == other.font_substitutes &&
      password == other.password &&
      comments_position == other.comments_position &&
      notes_position == other.notes_position
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



351
352
353
354
355
356
357
358
359
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
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 351

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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 = GroupDocsConversionCloud.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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 418

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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 327

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


308
309
310
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 308

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 314

def hash
  [format, preserve_document_structure, clear_custom_document_properties, clear_built_in_document_properties, depth, convert_owned, convert_owner, show_hidden_slides, default_font, font_substitutes, password, comments_position, notes_position].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



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
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 198

def list_invalid_properties
  invalid_properties = []
  if @preserve_document_structure.nil?
    invalid_properties.push("invalid value for 'preserve_document_structure', preserve_document_structure cannot be nil.")
  end

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

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

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

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

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

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

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

  if @notes_position.nil?
    invalid_properties.push("invalid value for 'notes_position', notes_position cannot be nil.")
  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



398
399
400
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 398

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



404
405
406
407
408
409
410
411
412
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 404

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



392
393
394
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 392

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



320
321
322
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 320

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/groupdocs_conversion_cloud/models/presentation_load_options.rb', line 241

def valid?
  return false if @preserve_document_structure.nil?
  return false if @clear_custom_document_properties.nil?
  return false if @clear_built_in_document_properties.nil?
  return false if @depth.nil?
  return false if @convert_owned.nil?
  return false if @convert_owner.nil?
  return false if @show_hidden_slides.nil?
  return false if @comments_position.nil?
  comments_position_validator = EnumAttributeValidator.new('String', ["None", "Bottom", "Right"])
  return false unless comments_position_validator.valid?(@comments_position)
  return false if @notes_position.nil?
  notes_position_validator = EnumAttributeValidator.new('String', ["None", "BottomTruncated", "BottomFull"])
  return false unless notes_position_validator.valid?(@notes_position)
  return true
end