Class: GroupDocsSignatureCloud::DigitalSignatureAppearance

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

Overview

Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DigitalSignatureAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 89

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

  if attributes.key?(:'Email')
    self.email = attributes[:'Email']
  end

  if attributes.key?(:'Signer')
    self.signer = attributes[:'Signer']
  end

  if attributes.key?(:'Title')
    self.title = attributes[:'Title']
  end

end

Instance Attribute Details

#appearance_type ⇒ Object

Specifies the type of appearance



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

def appearance_type
  @appearance_type
end

#email ⇒ Object

Gets or sets a email that will be displayed in signature line.



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

def email
  @email
end

#signer ⇒ Object

Gets or sets signer name for signature line.



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

def signer
  @signer
end

#title ⇒ Object

Gets or sets a title for signature line.



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 68

def self.attribute_map
  {
    :'appearance_type' => :'AppearanceType',
    :'email' => :'Email',
    :'signer' => :'Signer',
    :'title' => :'Title'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 78

def self.swagger_types
  {
    :'appearance_type' => :'String',
    :'email' => :'String',
    :'signer' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 149

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      appearance_type == other.appearance_type &&
      email == other.email &&
      signer == other.signer &&
      title == other.title
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



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 203

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 293

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 179

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


160
161
162
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 166

def hash
  [appearance_type, email, signer, title].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



115
116
117
118
119
120
121
122
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 115

def list_invalid_properties
  invalid_properties = []
  if @appearance_type.nil?
    invalid_properties.push("invalid value for 'appearance_type', appearance_type 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



273
274
275
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 279

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



267
268
269
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 267

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



172
173
174
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 172

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



126
127
128
129
130
131
 
# File 'lib/groupdocs_signature_cloud/models/digital_signature_appearance.rb', line 126

def valid?
  return false if @appearance_type.nil?
  appearance_type_validator = EnumAttributeValidator.new('String', ["Undefined", "PdfTextAnnotation", "PdfTextSticker", "Image", "DigitalSignature", "PdfDigitalSignature"])
  return false unless appearance_type_validator.valid?(@appearance_type)
  return true
end