class AsposePdfCloud::SignatureCustomAppearance

An abstract class which represents signature custom appearance object.

Attributes

contact_info_label[RW]

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

date_signed_at_label[RW]

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

date_time_format[RW]

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

date_time_local_format[RW]

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

digital_signed_label[RW]

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

font_family_name[RW]

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

font_size[RW]

Gets/sets font size. Default value: 10.

location_label[RW]

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

reason_label[RW]

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

show_contact_info[RW]

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

show_location[RW]

Gets/sets location visibility. Default value: true.

show_reason[RW]

Gets/sets reason visibility. Default value: true.

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose_pdf_cloud/models/signature_custom_appearance.rb, line 213
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/signature_custom_appearance.rb, line 293
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_pdf_cloud/models/signature_custom_appearance.rb, line 287
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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