class AsposeCellsCloud::DigitalSignature

Attributes

comments[RW]

The purpose to signature.

id[RW]

Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content. Default value is Empty (all zeroes) Guid.

image[RW]

Specifies an image for the digital signature. Default value is null.

is_valid[RW]

If this digital signature is valid and the document has not been tampered with, this value will be true.

password[RW]

Specifies the text of actual signature in the digital signature. Default value is Empty.

provider_id[RW]

Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.

sign_time[RW]

The time when the document was signed.

x_ad_es_type[RW]

XAdES type. Default value is None(XAdES is off).

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_cells_cloud/models/digital_signature.rb, line 52
def self.attribute_map
  {
    :'comments' => :'Comments',
    :'sign_time' => :'SignTime',
    :'id' => :'Id',
    :'password' => :'Password',
    :'image' => :'Image',
    :'provider_id' => :'ProviderId',
    :'is_valid' => :'IsValid',
    :'x_ad_es_type' => :'XAdESType'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/aspose_cells_cloud/models/digital_signature.rb, line 81
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?(:'Comments')
      self.comments = attributes[:'Comments']
  end
  if attributes.has_key?(:'SignTime')
      self.sign_time = attributes[:'SignTime']
  end
  if attributes.has_key?(:'Id')
      self.id = attributes[:'Id']
  end
  if attributes.has_key?(:'Password')
      self.password = attributes[:'Password']
  end
  if attributes.has_key?(:'Image')
      self.image = attributes[:'Image']
  end
  if attributes.has_key?(:'ProviderId')
      self.provider_id = attributes[:'ProviderId']
  end
  if attributes.has_key?(:'IsValid')
      self.is_valid = attributes[:'IsValid']
  end
  if attributes.has_key?(:'XAdESType')
      self.x_ad_es_type = attributes[:'XAdESType']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/digital_signature.rb, line 66
def self.swagger_types
  {
    :'comments' => :'String',
    :'sign_time' => :'String',
    :'id' => :'String',
    :'password' => :'String',
    :'image' => :'Array<Integer>',
    :'provider_id' => :'String',
    :'is_valid' => :'BOOLEAN',
    :'x_ad_es_type' => :'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_cells_cloud/models/digital_signature.rb, line 162
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comments == o.comments &&
      sign_time == o.sign_time &&
      id == o.id &&
      password == o.password &&
      image == o.image &&
      provider_id == o.provider_id &&
      is_valid == o.is_valid &&
      x_ad_es_type == o.x_ad_es_type 
      std_dev == o.std_dev
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_cells_cloud/models/digital_signature.rb, line 212
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 = AsposeCellsCloud.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_cells_cloud/models/digital_signature.rb, line 278
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_cells_cloud/models/digital_signature.rb, line 191
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_cells_cloud/models/digital_signature.rb, line 178
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_cells_cloud/models/digital_signature.rb, line 184
def hash
  [ comments , sign_time , id , password , image , provider_id , is_valid , x_ad_es_type ].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_cells_cloud/models/digital_signature.rb, line 116
def list_invalid_properties
  invalid_properties = Array.new
  if @comments.nil?
      invalid_properties.push("invalid value for 'comments', comments cannot be nil.")
  end
  if @sign_time.nil?
      invalid_properties.push("invalid value for 'sign_time', sign_time cannot be nil.")
  end
  if @id.nil?
      invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end
  if @password.nil?
      invalid_properties.push("invalid value for 'password', password cannot be nil.")
  end
  if @image.nil?
      invalid_properties.push("invalid value for 'image', image cannot be nil.")
  end
  if @provider_id.nil?
      invalid_properties.push("invalid value for 'provider_id', provider_id cannot be nil.")
  end
  if @is_valid.nil?
      invalid_properties.push("invalid value for 'is_valid', is_valid cannot be nil.")
  end
  if @x_ad_es_type.nil?
      invalid_properties.push("invalid value for 'x_ad_es_type', x_ad_es_type 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_cells_cloud/models/digital_signature.rb, line 258
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_cells_cloud/models/digital_signature.rb, line 264
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_cells_cloud/models/digital_signature.rb, line 252
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_cells_cloud/models/digital_signature.rb, line 148
def valid?
  return false if @comments.nil?
  return false if @sign_time.nil?
  return false if @id.nil?
  return false if @password.nil?
  return false if @image.nil?
  return false if @provider_id.nil?
  return false if @is_valid.nil?
  return false if @x_ad_es_type.nil?
  return true
end