Class: AsposePdfCloud::SignatureCustomAppearance

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

Overview

An abstract class which represents signature custom appearance object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureCustomAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.has_key?(:'FontSize')
    self.font_size = attributes[:'FontSize']
  end

  if attributes.has_key?(:'ShowContactInfo')
    self.show_contact_info = attributes[:'ShowContactInfo']
  end

  if attributes.has_key?(:'ShowReason')
    self.show_reason = attributes[:'ShowReason']
  end

  if attributes.has_key?(:'ShowLocation')
    self.show_location = attributes[:'ShowLocation']
  end

  if attributes.has_key?(:'ContactInfoLabel')
    self.contact_info_label = attributes[:'ContactInfoLabel']
  end

  if attributes.has_key?(:'ReasonLabel')
    self.reason_label = attributes[:'ReasonLabel']
  end

  if attributes.has_key?(:'LocationLabel')
    self.location_label = attributes[:'LocationLabel']
  end

  if attributes.has_key?(:'DigitalSignedLabel')
    self.digital_signed_label = attributes[:'DigitalSignedLabel']
  end

  if attributes.has_key?(:'DateSignedAtLabel')
    self.date_signed_at_label = attributes[:'DateSignedAtLabel']
  end

  if attributes.has_key?(:'DateTimeLocalFormat')
    self.date_time_local_format = attributes[:'DateTimeLocalFormat']
  end

  if attributes.has_key?(:'DateTimeFormat')
    self.date_time_format = attributes[:'DateTimeFormat']
  end

end

Instance Attribute Details

#contact_info_label ⇒ Object

Gets/sets contact info label. Default value: "Contact".



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

def contact_info_label
  @contact_info_label
end

#date_signed_at_label ⇒ Object

Gets/sets date signed label. Default value: "Date".



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

def date_signed_at_label
  @date_signed_at_label
end

#date_time_format ⇒ Object

Gets/sets datetime format. Default value: "yyyy.MM.dd HH:mm:ss".



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

def date_time_format
  @date_time_format
end

#date_time_local_format ⇒ Object

Gets/sets datetime local format. Default value: "yyyy.MM.dd HH:mm:ss zzz".



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

def date_time_local_format
  @date_time_local_format
end

#digital_signed_label ⇒ Object

Gets/sets digital signed label. Default value: "Digitally signed by".



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

def digital_signed_label
  @digital_signed_label
end

#font_family_name ⇒ Object

Gets/sets font family name. It should be existed in the document. Default value: Arial.



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

def font_family_name
  @font_family_name
end

#font_size ⇒ Object

Gets/sets font size. Default value: 10.



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

def font_size
  @font_size
end

#location_label ⇒ Object

Gets/sets location label. Default value: "Location".



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

def location_label
  @location_label
end

#reason_label ⇒ Object

Gets/sets reason label. Default value: "Reason".



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

def reason_label
  @reason_label
end

#show_contact_info ⇒ Object

Gets/sets contact info visibility. Default value: true.



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

def show_contact_info
  @show_contact_info
end

#show_location ⇒ Object

Gets/sets location visibility. Default value: true.



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

def show_location
  @show_location
end

#show_reason ⇒ Object

Gets/sets reason visibility. Default value: true.



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

def show_reason
  @show_reason
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 66

def self.attribute_map
  {
    :'font_family_name' => :'FontFamilyName',
    :'font_size' => :'FontSize',
    :'show_contact_info' => :'ShowContactInfo',
    :'show_reason' => :'ShowReason',
    :'show_location' => :'ShowLocation',
    :'contact_info_label' => :'ContactInfoLabel',
    :'reason_label' => :'ReasonLabel',
    :'location_label' => :'LocationLabel',
    :'digital_signed_label' => :'DigitalSignedLabel',
    :'date_signed_at_label' => :'DateSignedAtLabel',
    :'date_time_local_format' => :'DateTimeLocalFormat',
    :'date_time_format' => :'DateTimeFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 84

def self.swagger_types
  {
    :'font_family_name' => :'String',
    :'font_size' => :'Float',
    :'show_contact_info' => :'BOOLEAN',
    :'show_reason' => :'BOOLEAN',
    :'show_location' => :'BOOLEAN',
    :'contact_info_label' => :'String',
    :'reason_label' => :'String',
    :'location_label' => :'String',
    :'digital_signed_label' => :'String',
    :'date_signed_at_label' => :'String',
    :'date_time_local_format' => :'String',
    :'date_time_format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      font_family_name == o.font_family_name &&
      font_size == o.font_size &&
      show_contact_info == o.show_contact_info &&
      show_reason == o.show_reason &&
      show_location == o.show_location &&
      contact_info_label == o.contact_info_label &&
      reason_label == o.reason_label &&
      location_label == o.location_label &&
      digital_signed_label == o.digital_signed_label &&
      date_signed_at_label == o.date_signed_at_label &&
      date_time_local_format == o.date_time_local_format &&
      date_time_format == o.date_time_format
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



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

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 313

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

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


213
214
215
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 219

def hash
  [font_family_name, font_size, show_contact_info, show_reason, show_location, contact_info_label, reason_label, location_label, digital_signed_label, date_signed_at_label, date_time_local_format, date_time_format].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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 161

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

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

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

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



293
294
295
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 293

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



299
300
301
302
303
304
305
306
307
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 299

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



287
288
289
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 287

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



184
185
186
187
188
189
190
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 184

def valid?
  return false if @font_size.nil?
  return false if @show_contact_info.nil?
  return false if @show_reason.nil?
  return false if @show_location.nil?
  return true
end