Class: AsposeWordsCloud::SignOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/sign_options.rb

Overview

Container class for digital signature options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 75

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

  if attributes.key?(:'DecryptionPassword')
    self.decryption_password = attributes[:'DecryptionPassword']
  end

  if attributes.key?(:'ProviderId')
    self.provider_id = attributes[:'ProviderId']
  end

  if attributes.key?(:'SignatureLineId')
    self.signature_line_id = attributes[:'SignatureLineId']
  end

  if attributes.key?(:'SignatureLineImageFilename')
    self.signature_line_image_filename = attributes[:'SignatureLineImageFilename']
  end

  if attributes.key?(:'SignTime')
    self.sign_time = attributes[:'SignTime']
  end
end

Instance Attribute Details

#comments ⇒ Object

Gets or sets comments on the digital signature. Default value is empty string.



33
34
35
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 33

def comments
  @comments
end

#decryption_password ⇒ Object

Gets or sets the password to decrypt source document. Default value is empty string.



36
37
38
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 36

def decryption_password
  @decryption_password
end

#provider_id ⇒ Object

Gets or sets the class Guid of the signature cryptography provider. Default value is Empty (all zeroes) Guid.



39
40
41
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 39

def provider_id
  @provider_id
end

#sign_time ⇒ Object

Gets or sets the date of signing. Default value is current time (Now).



48
49
50
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 48

def sign_time
  @sign_time
end

#signature_line_id ⇒ Object

Gets or sets user defined signature line Guid. Default value is Empty (all zeroes) Guid.



42
43
44
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 42

def signature_line_id
  @signature_line_id
end

#signature_line_image_filename ⇒ Object

Gets or sets the image that will be shown in associated SignatureLine. Default value is empty string.



45
46
47
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 45

def signature_line_image_filename
  @signature_line_image_filename
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 50

def self.attribute_map
  {
    :'comments' => :'Comments',
    :'decryption_password' => :'DecryptionPassword',
    :'provider_id' => :'ProviderId',
    :'signature_line_id' => :'SignatureLineId',
    :'signature_line_image_filename' => :'SignatureLineImageFilename',
    :'sign_time' => :'SignTime'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 62

def self.swagger_types
  {
    :'comments' => :'String',
    :'decryption_password' => :'String',
    :'provider_id' => :'String',
    :'signature_line_id' => :'String',
    :'signature_line_image_filename' => :'String',
    :'sign_time' => :'DateTime'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 114

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      comments == other.comments &&
      decryption_password == other.decryption_password &&
      provider_id == other.provider_id &&
      signature_line_id == other.signature_line_id &&
      signature_line_image_filename == other.signature_line_image_filename &&
      sign_time == other.sign_time
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 162

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 233

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 140

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

#collectFilesContent(resultFilesContent) ⇒ Object 



247
248
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 247

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


127
128
129
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 133

def hash
  [comments, decryption_password, provider_id, signature_line_id, signature_line_image_filename, sign_time].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 213

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 219

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



207
208
209
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 207

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



108
109
110
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 108

def valid?
  return true
end

#validate ⇒ Object 



250
251
 
# File 'lib/aspose_words_cloud/models/sign_options.rb', line 250

def validate()
end