Class: GroupDocsAnnotationCloud::PreviewOptions

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

Overview

Represents options for GetPages API method

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



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

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

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

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

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

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

  if attributes.key?(:'RenderComments')
    self.render_comments = attributes[:'RenderComments']
  end

  if attributes.key?(:'RenderAnnotations')
    self.render_annotations = attributes[:'RenderAnnotations']
  end

  if attributes.key?(:'FontsPath')
    self.fonts_path = attributes[:'FontsPath']
  end

end

Instance Attribute Details

#file_info ⇒ Object

Input document description



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

def file_info
  @file_info
end

#fonts_path ⇒ Object

The path to directory containing custom fonts in storage



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

def fonts_path
  @fonts_path
end

#format ⇒ Object

Preview format. Supported values are: PNG, JPEG or BMP. Default value is PNG.



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

def format
  @format
end

#height ⇒ Object

Preview image height. Not required. Default width used if not specified or 0.



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

def height
  @height
end

#page_numbers ⇒ Object

Page numbers to preview. All pages proceeded if not specified.



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

def page_numbers
  @page_numbers
end

#render_annotations ⇒ Object

The property that controls whether annotations will be generated on the preview. Default State - true.



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

def render_annotations
  @render_annotations
end

#render_comments ⇒ Object

Render document comments. Default value is ‘false’.



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

def render_comments
  @render_comments
end

#resolution ⇒ Object

Gets or sets the resolution for generated images, in dots per inch. The default value is 96.



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

def resolution
  @resolution
end

#width ⇒ Object

Preview image width. Not required. Default width used if not specified or 0.



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

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'format' => :'Format',
    :'page_numbers' => :'PageNumbers',
    :'width' => :'Width',
    :'height' => :'Height',
    :'resolution' => :'Resolution',
    :'render_comments' => :'RenderComments',
    :'render_annotations' => :'RenderAnnotations',
    :'fonts_path' => :'FontsPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'format' => :'String',
    :'page_numbers' => :'Array<Integer>',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'resolution' => :'Integer',
    :'render_comments' => :'BOOLEAN',
    :'render_annotations' => :'BOOLEAN',
    :'fonts_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 222

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      format == other.format &&
      page_numbers == other.page_numbers &&
      width == other.width &&
      height == other.height &&
      resolution == other.resolution &&
      render_comments == other.render_comments &&
      render_annotations == other.render_annotations &&
      fonts_path == other.fonts_path
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 281

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 348

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 257

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


238
239
240
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 238

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 244

def hash
  [file_info, format, page_numbers, width, height, resolution, render_comments, render_annotations, fonts_path].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



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

def list_invalid_properties
  invalid_properties = []
  if @format.nil?
    invalid_properties.push("invalid value for 'format', format 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 @resolution.nil?
    invalid_properties.push("invalid value for 'resolution', resolution cannot be nil.")
  end

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

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



328
329
330
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 328

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



334
335
336
337
338
339
340
341
342
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 334

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



322
323
324
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 322

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



250
251
252
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 250

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



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/groupdocs_annotation_cloud/models/preview_options.rb', line 193

def valid?
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new('String', ["PNG", "JPEG", "BMP"])
  return false unless format_validator.valid?(@format)
  return false if @width.nil?
  return false if @height.nil?
  return false if @resolution.nil?
  return false if @render_comments.nil?
  return false if @render_annotations.nil?
  return true
end