Class: GroupDocsSignatureCloud::MetadataSignature

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

Overview

Contains Metadata signature properties.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetadataSignature

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
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_signature_cloud/models/metadata_signature.rb', line 159

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

  if attributes.key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end

  if attributes.key?(:'SignatureId')
    self.signature_id = attributes[:'SignatureId']
  end

  if attributes.key?(:'IsSignature')
    self.is_signature = attributes[:'IsSignature']
  end

  if attributes.key?(:'CreatedOn')
    self.created_on = attributes[:'CreatedOn']
  end

  if attributes.key?(:'ModifiedOn')
    self.modified_on = attributes[:'ModifiedOn']
  end

  if attributes.key?(:'Top')
    self.top = attributes[:'Top']
  end

  if attributes.key?(:'Left')
    self.left = attributes[:'Left']
  end

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

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

  if attributes.key?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.key?(:'DataType')
    self.data_type = attributes[:'DataType']
  end

  if attributes.key?(:'Value')
    self.value = attributes[:'Value']
  end

  if attributes.key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.key?(:'Size')
    self.size = attributes[:'Size']
  end

  if attributes.key?(:'Description')
    self.description = attributes[:'Description']
  end

  if attributes.key?(:'TagPrefix')
    self.tag_prefix = attributes[:'TagPrefix']
  end

end

Instance Attribute Details

#created_on ⇒ Object

Get or set the signature creation date



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

def created_on
  @created_on
end

#data_type ⇒ Object

Specifies metadata value type.



68
69
70
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 68

def data_type
  @data_type
end

#description ⇒ Object

Description for standard Image Metadata signature



83
84
85
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 83

def description
  @description
end

#height ⇒ Object

Specifies height of signature



62
63
64
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 62

def height
  @height
end

#id ⇒ Object

The identifier of Image Metadata signature. See GroupDocs.Signature.Domain.ImageMetadataSignatures class that contains standard Signature with predefined Id value.



77
78
79
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 77

def id
  @id
end

#is_signature ⇒ Object

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).



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

def is_signature
  @is_signature
end

#left ⇒ Object

Specifies left position of signature



56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 56

def left
  @left
end

#modified_on ⇒ Object

Get or set the signature modification date



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

def modified_on
  @modified_on
end

#name ⇒ Object

Specifies unique metadata name



74
75
76
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 74

def name
  @name
end

#page_number ⇒ Object

Specifies the page signature was found on



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

def page_number
  @page_number
end

#signature_id ⇒ Object

Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.



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

def signature_id
  @signature_id
end

#signature_type ⇒ Object

Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)



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

def signature_type
  @signature_type
end

#size ⇒ Object

Size of Image Metadata value



80
81
82
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 80

def size
  @size
end

#tag_prefix ⇒ Object

The prefix tag of Pdf Metadata signature name. By default this property is set to "xmp". Possible values are



86
87
88
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 86

def tag_prefix
  @tag_prefix
end

#top ⇒ Object

Specifies top position of signature



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

def top
  @top
end

#type ⇒ Object

Specifies metadata type.



65
66
67
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 65

def type
  @type
end

#value ⇒ Object

Specifies metadata object value



71
72
73
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 71

def value
  @value
end

#width ⇒ Object

Specifies width of signature



59
60
61
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 59

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 110

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'page_number' => :'PageNumber',
    :'signature_id' => :'SignatureId',
    :'is_signature' => :'IsSignature',
    :'created_on' => :'CreatedOn',
    :'modified_on' => :'ModifiedOn',
    :'top' => :'Top',
    :'left' => :'Left',
    :'width' => :'Width',
    :'height' => :'Height',
    :'type' => :'Type',
    :'data_type' => :'DataType',
    :'value' => :'Value',
    :'name' => :'Name',
    :'id' => :'Id',
    :'size' => :'Size',
    :'description' => :'Description',
    :'tag_prefix' => :'TagPrefix'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 134

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'page_number' => :'Integer',
    :'signature_id' => :'String',
    :'is_signature' => :'BOOLEAN',
    :'created_on' => :'DateTime',
    :'modified_on' => :'DateTime',
    :'top' => :'Integer',
    :'left' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'type' => :'String',
    :'data_type' => :'String',
    :'value' => :'String',
    :'name' => :'String',
    :'id' => :'Integer',
    :'size' => :'Integer',
    :'description' => :'String',
    :'tag_prefix' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 362

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      page_number == other.page_number &&
      signature_id == other.signature_id &&
      is_signature == other.is_signature &&
      created_on == other.created_on &&
      modified_on == other.modified_on &&
      top == other.top &&
      left == other.left &&
      width == other.width &&
      height == other.height &&
      type == other.type &&
      data_type == other.data_type &&
      value == other.value &&
      name == other.name &&
      id == other.id &&
      size == other.size &&
      description == other.description &&
      tag_prefix == other.tag_prefix
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 430

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



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 520

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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 406

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


387
388
389
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 387

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



393
394
395
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 393

def hash
  [signature_type, page_number, signature_id, is_signature, created_on, modified_on, top, left, width, height, type, data_type, value, name, id, size, description, tag_prefix].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



241
242
243
244
245
246
247
248
249
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
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 241

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

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

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

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

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

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

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

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

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



500
501
502
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 500

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



506
507
508
509
510
511
512
513
514
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 506

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



494
495
496
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 494

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



399
400
401
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 399

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/groupdocs_signature_cloud/models/metadata_signature.rb', line 296

def valid?
  return false if @signature_type.nil?
  signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
  return false unless signature_type_validator.valid?(@signature_type)
  return false if @is_signature.nil?
  return false if @created_on.nil?
  return false if @modified_on.nil?
  return false if @top.nil?
  return false if @left.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["None", "Certificate", "Image", "Pdf", "Presentation", "Spreadsheet", "WordProcessing"])
  return false unless type_validator.valid?(@type)
  return false if @data_type.nil?
  data_type_validator = EnumAttributeValidator.new('String', ["Undefined", "Boolean", "Integer", "Double", "DateTime", "String"])
  return false unless data_type_validator.valid?(@data_type)
  return false if @id.nil?
  return false if @size.nil?
  return true
end