Class: AsposeCellsCloud::DigitalSignature
- Inherits:
-
Object
- Object
- AsposeCellsCloud::DigitalSignature
- Defined in:
- lib/aspose_cells_cloud/models/digital_signature.rb
Instance Attribute Summary collapse
-
#comments ⇒ Object
The purpose to signature.
-
#id ⇒ Object
Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content.
-
#image ⇒ Object
Specifies an image for the digital signature.
-
#is_valid ⇒ Object
If this digital signature is valid and the document has not been tampered with, this value will be true.
-
#password ⇒ Object
Specifies the text of actual signature in the digital signature.
-
#provider_id ⇒ Object
Specifies the class ID of the signature provider.
-
#sign_time ⇒ Object
The time when the document was signed.
-
#x_ad_es_type ⇒ Object
XAdES type.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DigitalSignature
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ DigitalSignature
Initializes the object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# 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 |
Instance Attribute Details
#comments ⇒ Object
The purpose to signature.
35 36 37 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 35 def comments @comments end |
#id ⇒ Object
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.
39 40 41 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 39 def id @id end |
#image ⇒ Object
Specifies an image for the digital signature. Default value is null.
43 44 45 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 43 def image @image end |
#is_valid ⇒ Object
If this digital signature is valid and the document has not been tampered with, this value will be true.
47 48 49 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 47 def is_valid @is_valid end |
#password ⇒ Object
Specifies the text of actual signature in the digital signature. Default value is Empty.
41 42 43 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 41 def password @password end |
#provider_id ⇒ Object
Specifies the class ID of the signature provider. Default value is Empty (all zeroes) Guid.
45 46 47 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 45 def provider_id @provider_id end |
#sign_time ⇒ Object
The time when the document was signed.
37 38 39 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 37 def sign_time @sign_time end |
#x_ad_es_type ⇒ Object
XAdES type. Default value is None(XAdES is off).
49 50 51 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 49 def x_ad_es_type @x_ad_es_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 77 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
162 163 164 165 166 167 168 169 170 171 172 173 174 |
# 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) ⇒ Object
Deserializes the data based on type
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 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
278 279 280 281 282 283 284 285 286 287 288 289 290 |
# 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) ⇒ Object
Builds the object from hash
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# 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) ⇒ Boolean
178 179 180 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 178 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
184 185 186 |
# 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 ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# 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 ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
258 259 260 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 258 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
264 265 266 267 268 269 270 271 272 |
# 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 ⇒ String
Returns the string representation of the object
252 253 254 |
# File 'lib/aspose_cells_cloud/models/digital_signature.rb', line 252 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
148 149 150 151 152 153 154 155 156 157 158 |
# 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 |