Class: GroupDocsSignatureCloud::PreviewSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/preview_settings.rb

Overview

Defines preview request settings

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreviewSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
106
107
108
109
110
111
112
113
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
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 104

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

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

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

  if attributes.key?(:'PreviewFormat')
    self.preview_format = attributes[:'PreviewFormat']
  end

  if attributes.key?(:'HideSignatures')
    self.hide_signatures = attributes[:'HideSignatures']
  end

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

end

Instance Attribute Details

#file_info ⇒ Object

File info



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 35

def file_info
  @file_info
end

#height ⇒ Object

Preview images height



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 41

def height
  @height
end

#hide_signatures ⇒ Object

Flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image



50
51
52
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 50

def hide_signatures
  @hide_signatures
end

#output_path ⇒ Object

Set path for output pages. If not set then default path used.



53
54
55
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 53

def output_path
  @output_path
end

#page_numbers ⇒ Object

Preview page numbers



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 44

def page_numbers
  @page_numbers
end

#preview_format ⇒ Object

Preview format



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 47

def preview_format
  @preview_format
end

#width ⇒ Object

Preview images width



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 38

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 77

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'width' => :'Width',
    :'height' => :'Height',
    :'page_numbers' => :'PageNumbers',
    :'preview_format' => :'PreviewFormat',
    :'hide_signatures' => :'HideSignatures',
    :'output_path' => :'OutputPath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 90

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'page_numbers' => :'Array<Integer>',
    :'preview_format' => :'String',
    :'hide_signatures' => :'BOOLEAN',
    :'output_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      width == other.width &&
      height == other.height &&
      page_numbers == other.page_numbers &&
      preview_format == other.preview_format &&
      hide_signatures == other.hide_signatures &&
      output_path == other.output_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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 250

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
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 340

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 226

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


207
208
209
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 213

def hash
  [file_info, width, height, page_numbers, preview_format, hide_signatures, output_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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 144

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

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



320
321
322
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 320

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



326
327
328
329
330
331
332
333
334
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 326

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



314
315
316
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 314

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



219
220
221
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 219

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



167
168
169
170
171
172
173
174
175
 
# File 'lib/groupdocs_signature_cloud/models/preview_settings.rb', line 167

def valid?
  return false if @width.nil?
  return false if @height.nil?
  return false if @preview_format.nil?
  preview_format_validator = EnumAttributeValidator.new('String', ["PNG", "JPEG", "BMP"])
  return false unless preview_format_validator.valid?(@preview_format)
  return false if @hide_signatures.nil?
  return true
end