Class: GroupDocsMergerCloud::PreviewOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_merger_cloud/models/preview_options.rb

Overview

Represents document preview options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreviewOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 119

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

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'Pages')
    if (value = attributes[:'Pages']).is_a?(Array)
      self.pages = value
    end
  end

  if attributes.key?(:'StartPageNumber')
    self.start_page_number = attributes[:'StartPageNumber']
  end

  if attributes.key?(:'EndPageNumber')
    self.end_page_number = attributes[:'EndPageNumber']
  end

  if attributes.key?(:'RangeMode')
    self.range_mode = attributes[:'RangeMode']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.key?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'Resolution')
    self.resolution = attributes[:'Resolution']
  end

end

Instance Attribute Details

#end_page_number ⇒ Object

End page number. Ignored if Pages collection is not empty.



47
48
49
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 47

def end_page_number
  @end_page_number
end

#file_info ⇒ Object

File info



35
36
37
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 35

def file_info
  @file_info
end

#format ⇒ Object

Preview image format



59
60
61
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 59

def format
  @format
end

#height ⇒ Object

Preview height



56
57
58
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 56

def height
  @height
end

#output_path ⇒ Object

The output path.



38
39
40
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 38

def output_path
  @output_path
end

#pages ⇒ Object

List of page numbers to use in a specific API method. NOTE: page numbering starts from 1.



41
42
43
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 41

def pages
  @pages
end

#range_mode ⇒ Object

Range mode. Ignored if Pages collection is not empty. Default value is AllPages.



50
51
52
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 50

def range_mode
  @range_mode
end

#resolution ⇒ Object

Preview image resolution (DPI). When 0, the default resolution is used.



62
63
64
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 62

def resolution
  @resolution
end

#start_page_number ⇒ Object

Start page number. Ignored if Pages collection is not empty.



44
45
46
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 44

def start_page_number
  @start_page_number
end

#width ⇒ Object

Preview width



53
54
55
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 53

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 86

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'OutputPath',
    :'pages' => :'Pages',
    :'start_page_number' => :'StartPageNumber',
    :'end_page_number' => :'EndPageNumber',
    :'range_mode' => :'RangeMode',
    :'width' => :'Width',
    :'height' => :'Height',
    :'format' => :'Format',
    :'resolution' => :'Resolution'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 102

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'String',
    :'pages' => :'Array<Integer>',
    :'start_page_number' => :'Integer',
    :'end_page_number' => :'Integer',
    :'range_mode' => :'String',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'format' => :'String',
    :'resolution' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 251

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      output_path == other.output_path &&
      pages == other.pages &&
      start_page_number == other.start_page_number &&
      end_page_number == other.end_page_number &&
      range_mode == other.range_mode &&
      width == other.width &&
      height == other.height &&
      format == other.format &&
      resolution == other.resolution
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



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
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 311

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 378

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



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

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


268
269
270
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 268

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 274

def hash
  [file_info, output_path, pages, start_page_number, end_page_number, range_mode, width, height, format, resolution].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



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
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 171

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

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

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

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

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

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

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



358
359
360
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 358

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



364
365
366
367
368
369
370
371
372
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 364

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



352
353
354
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 352

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



280
281
282
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 280

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/groupdocs_merger_cloud/models/preview_options.rb', line 206

def valid?
  return false if @start_page_number.nil?
  return false if @end_page_number.nil?
  return false if @range_mode.nil?
  range_mode_validator = EnumAttributeValidator.new('String', ["AllPages", "OddPages", "EvenPages"])
  return false unless range_mode_validator.valid?(@range_mode)
  return false if @width.nil?
  return false if @height.nil?
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new('String', ["Jpeg", "Png", "Bmp"])
  return false unless format_validator.valid?(@format)
  return false if @resolution.nil?
  return true
end