Class: AsposePdfCloud::Signature

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/signature.rb

Overview

Represents signature.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Signature

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 123

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

  if attributes.has_key?(:'SignatureType')
    self.signature_type = attributes[:'SignatureType']
  end

  if attributes.has_key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.has_key?(:'Appearance')
    self.appearance = attributes[:'Appearance']
  end

  if attributes.has_key?(:'Reason')
    self.reason = attributes[:'Reason']
  end

  if attributes.has_key?(:'Contact')
    self.contact = attributes[:'Contact']
  end

  if attributes.has_key?(:'Location')
    self.location = attributes[:'Location']
  end

  if attributes.has_key?(:'Visible')
    self.visible = attributes[:'Visible']
  end

  if attributes.has_key?(:'Rectangle')
    self.rectangle = attributes[:'Rectangle']
  end

  if attributes.has_key?(:'FormFieldName')
    self.form_field_name = attributes[:'FormFieldName']
  end

  if attributes.has_key?(:'Authority')
    self.authority = attributes[:'Authority']
  end

  if attributes.has_key?(:'Date')
    self.date = attributes[:'Date']
  end

  if attributes.has_key?(:'ShowProperties')
    self.show_properties = attributes[:'ShowProperties']
  end

  if attributes.has_key?(:'TimestampSettings')
    self.timestamp_settings = attributes[:'TimestampSettings']
  end

  if attributes.has_key?(:'IsValid')
    self.is_valid = attributes[:'IsValid']
  end

  if attributes.has_key?(:'CustomAppearance')
    self.custom_appearance = attributes[:'CustomAppearance']
  end

end

Instance Attribute Details

#appearance ⇒ Object

Sets or gets a graphic appearance for the signature. Property value represents an image file name.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 38

def appearance
  @appearance
end

#authority ⇒ Object

Gets or sets the name of the person or authority signing the document..



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 59

def authority
  @authority
end

#contact ⇒ Object

Gets or sets the contact of the signature.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 44

def contact
  @contact
end

#custom_appearance ⇒ Object

Gets/sets the custom appearance.



74
75
76
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 74

def custom_appearance
  @custom_appearance
end

#date ⇒ Object

Gets or sets the time of signing.



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 62

def date
  @date
end

#form_field_name ⇒ Object

Gets or sets the name of the signature field. Supports only when signing document with particular form field.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 56

def form_field_name
  @form_field_name
end

#is_valid ⇒ Object

Verify the document regarding this signature and return true if document is valid or otherwise false.



71
72
73
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 71

def is_valid
  @is_valid
end

#location ⇒ Object

Gets or sets the location of the signature.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 47

def location
  @location
end

#password ⇒ Object

Gets or sets the signature password.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 35

def password
  @password
end

#reason ⇒ Object

Gets or sets the reason of the signature.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 41

def reason
  @reason
end

#rectangle ⇒ Object

Gets or sets the visible rectangle of the signature. Supports only when signing particular page.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 53

def rectangle
  @rectangle
end

#show_properties ⇒ Object

Gets or sets the showproperties in signature field



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 65

def show_properties
  @show_properties
end

#signature_path ⇒ Object

Gets or sets the signature path.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 29

def signature_path
  @signature_path
end

#signature_type ⇒ Object

Gets or sets the type of the signature.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 32

def signature_type
  @signature_type
end

#timestamp_settings ⇒ Object

Gets/sets timestamp settings.



68
69
70
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 68

def timestamp_settings
  @timestamp_settings
end

#visible ⇒ Object

Gets or sets a value indicating whether this Signature is visible. Supports only when signing particular page.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 50

def visible
  @visible
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 78

def self.attribute_map
  {
    :'signature_path' => :'SignaturePath',
    :'signature_type' => :'SignatureType',
    :'password' => :'Password',
    :'appearance' => :'Appearance',
    :'reason' => :'Reason',
    :'contact' => :'Contact',
    :'location' => :'Location',
    :'visible' => :'Visible',
    :'rectangle' => :'Rectangle',
    :'form_field_name' => :'FormFieldName',
    :'authority' => :'Authority',
    :'date' => :'Date',
    :'show_properties' => :'ShowProperties',
    :'timestamp_settings' => :'TimestampSettings',
    :'is_valid' => :'IsValid',
    :'custom_appearance' => :'CustomAppearance'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 100

def self.swagger_types
  {
    :'signature_path' => :'String',
    :'signature_type' => :'SignatureType',
    :'password' => :'String',
    :'appearance' => :'String',
    :'reason' => :'String',
    :'contact' => :'String',
    :'location' => :'String',
    :'visible' => :'BOOLEAN',
    :'rectangle' => :'Rectangle',
    :'form_field_name' => :'String',
    :'authority' => :'String',
    :'date' => :'String',
    :'show_properties' => :'BOOLEAN',
    :'timestamp_settings' => :'TimestampSettings',
    :'is_valid' => :'BOOLEAN',
    :'custom_appearance' => :'SignatureCustomAppearance'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      signature_path == o.signature_path &&
      signature_type == o.signature_type &&
      password == o.password &&
      appearance == o.appearance &&
      reason == o.reason &&
      contact == o.contact &&
      location == o.location &&
      visible == o.visible &&
      rectangle == o.rectangle &&
      form_field_name == o.form_field_name &&
      authority == o.authority &&
      date == o.date &&
      show_properties == o.show_properties &&
      timestamp_settings == o.timestamp_settings &&
      is_valid == o.is_valid &&
      custom_appearance == o.custom_appearance
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



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
338
339
340
341
342
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 306

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 = AsposePdfCloud.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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 372

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 285

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 278

def hash
  [signature_path, signature_type, password, appearance, reason, contact, location, visible, rectangle, form_field_name, authority, date, show_properties, timestamp_settings, is_valid, custom_appearance].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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  if @signature_path.nil?
    invalid_properties.push("invalid value for 'signature_path', signature_path cannot be nil.")
  end

  if @signature_path.to_s.length < 1
    invalid_properties.push("invalid value for 'signature_path', the character length must be great than or equal to 1.")
  end

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

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

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



352
353
354
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 352

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



358
359
360
361
362
363
364
365
366
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 358

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



346
347
348
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 346

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



224
225
226
227
228
229
230
231
 
# File 'lib/aspose_pdf_cloud/models/signature.rb', line 224

def valid?
  return false if @signature_path.nil?
  return false if @signature_path.to_s.length < 1
  return false if @signature_type.nil?
  return false if @visible.nil?
  return false if @show_properties.nil?
  return true
end