Class: GroupDocsConversionCloud::WebLoadOptions

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

Overview

Html document load options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 115

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

  if attributes.key?(:'BasePath')
    self.base_path = attributes[:'BasePath']
  end

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

  if attributes.key?(:'SkipExternalResources')
    self.skip_external_resources = attributes[:'SkipExternalResources']
  end

  if attributes.key?(:'UsePdf')
    self.use_pdf = attributes[:'UsePdf']
  end

  if attributes.key?(:'RenderingMode')
    self.rendering_mode = attributes[:'RenderingMode']
  end

  if attributes.key?(:'Zoom')
    self.zoom = attributes[:'Zoom']
  end

  if attributes.key?(:'PageLayout')
    self.page_layout = attributes[:'PageLayout']
  end

  if attributes.key?(:'CustomCssStyle')
    self.custom_css_style = attributes[:'CustomCssStyle']
  end

end

Instance Attribute Details

#base_path ⇒ Object

The base path/url for the html



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

def base_path
  @base_path
end

#custom_css_style ⇒ Object

Returns the value of attribute custom_css_style.



58
59
60
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 58

def custom_css_style
  @custom_css_style
end

#encoding ⇒ Object

Get or sets the encoding to be used when loading the web document. If the property is null the encoding will be determined from document character set attribute



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

def encoding
  @encoding
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/web_load_options.rb', line 35

def format
  @format
end

#page_layout ⇒ Object

Specifies the page layout options when loading web documents



57
58
59
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 57

def page_layout
  @page_layout
end

#page_numbering ⇒ Object

Enable or disable generation of page numbering in converted document. Default: false



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

def page_numbering
  @page_numbering
end

#rendering_mode ⇒ Object

Controls how HTML content is rendered. Default: AbsolutePositioning



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

def rendering_mode
  @rendering_mode
end

#skip_external_resources ⇒ Object

If true all external resource will not be loading



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

def skip_external_resources
  @skip_external_resources
end

#use_pdf ⇒ Object

Use pdf for the conversion. Default: false



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

def use_pdf
  @use_pdf
end

#zoom ⇒ Object

Returns the value of attribute zoom.



54
55
56
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 54

def zoom
  @zoom
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 82

def self.attribute_map
  {
    :'format' => :'Format',
    :'page_numbering' => :'PageNumbering',
    :'base_path' => :'BasePath',
    :'encoding' => :'Encoding',
    :'skip_external_resources' => :'SkipExternalResources',
    :'use_pdf' => :'UsePdf',
    :'rendering_mode' => :'RenderingMode',
    :'zoom' => :'Zoom',
    :'page_layout' => :'PageLayout',
    :'custom_css_style' => :'CustomCssStyle'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'format' => :'String',
    :'page_numbering' => :'BOOLEAN',
    :'base_path' => :'String',
    :'encoding' => :'String',
    :'skip_external_resources' => :'BOOLEAN',
    :'use_pdf' => :'BOOLEAN',
    :'rendering_mode' => :'String',
    :'zoom' => :'Integer',
    :'page_layout' => :'String',
    :'custom_css_style' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      page_numbering == other.page_numbering &&
      base_path == other.base_path &&
      encoding == other.encoding &&
      skip_external_resources == other.skip_external_resources &&
      use_pdf == other.use_pdf &&
      rendering_mode == other.rendering_mode &&
      zoom == other.zoom &&
      page_layout == other.page_layout &&
      custom_css_style == other.custom_css_style
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 300

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 367

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 276

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


257
258
259
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 257

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 263

def hash
  [format, page_numbering, base_path, encoding, skip_external_resources, use_pdf, rendering_mode, zoom, page_layout, custom_css_style].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



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

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

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

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

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

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

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



347
348
349
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 347

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



353
354
355
356
357
358
359
360
361
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 353

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



341
342
343
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 341

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



269
270
271
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 269

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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 196

def valid?
  return false if @page_numbering.nil?
  return false if @skip_external_resources.nil?
  return false if @use_pdf.nil?
  return false if @rendering_mode.nil?
  rendering_mode_validator = EnumAttributeValidator.new('String', ["Flow", "AbsolutePositioning"])
  return false unless rendering_mode_validator.valid?(@rendering_mode)
  return false if @zoom.nil?
  return false if @page_layout.nil?
  page_layout_validator = EnumAttributeValidator.new('String', ["None", "ScaleToPageWidth", "ScaleToPageHeight"])
  return false unless page_layout_validator.valid?(@page_layout)
  return true
end