Class: GroupDocsSignatureCloud::SearchBarcodeOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/search_barcode_options.rb

Overview

Defines options to Search barcode signature within a document

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchBarcodeOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 104

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

  if attributes.key?(:'Page')
    self.page = attributes[:'Page']
  end

  if attributes.key?(:'AllPages')
    self.all_pages = attributes[:'AllPages']
  end

  if attributes.key?(:'PagesSetup')
    self.pages_setup = attributes[:'PagesSetup']
  end

  if attributes.key?(:'BarcodeType')
    self.barcode_type = attributes[:'BarcodeType']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end

  if attributes.key?(:'MatchType')
    self.match_type = attributes[:'MatchType']
  end

end

Instance Attribute Details

#all_pages ⇒ Object

Process all document pages. Type of processing depends on SignatureType For Images Document Type it can be used only for multi-frames images like .tiff



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 41

def all_pages
  @all_pages
end

#barcode_type ⇒ Object

Specifies encode type property to search barcodes. If this value is not set, search is processed for all supported barcode Types



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 47

def barcode_type
  @barcode_type
end

#match_type ⇒ Object

Get or set barcode text match type search. It is used only when Text property is set



53
54
55
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 53

def match_type
  @match_type
end

#page ⇒ Object

Gets or sets a document page number for processing. Value is optional



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 38

def page
  @page
end

#pages_setup ⇒ Object

Options to specify pages for processing



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 44

def pages_setup
  @pages_setup
end

#signature_type ⇒ Object

Specifies the signature type of processing



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 35

def signature_type
  @signature_type
end

#text ⇒ Object

Specifies text for searching and matching in barcode signature



50
51
52
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 50

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 77

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'page' => :'Page',
    :'all_pages' => :'AllPages',
    :'pages_setup' => :'PagesSetup',
    :'barcode_type' => :'BarcodeType',
    :'text' => :'Text',
    :'match_type' => :'MatchType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 90

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'page' => :'Integer',
    :'all_pages' => :'BOOLEAN',
    :'pages_setup' => :'PagesSetup',
    :'barcode_type' => :'String',
    :'text' => :'String',
    :'match_type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 202

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      page == other.page &&
      all_pages == other.all_pages &&
      pages_setup == other.pages_setup &&
      barcode_type == other.barcode_type &&
      text == other.text &&
      match_type == other.match_type
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



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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 259

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 349

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 235

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?                  
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 216

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 222

def hash
  [signature_type, page, all_pages, pages_setup, barcode_type, text, match_type].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 142

def list_invalid_properties
  invalid_properties = []
  if @signature_type.nil?
    invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.")
  end

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

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



329
330
331
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 329

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



335
336
337
338
339
340
341
342
343
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 335

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



323
324
325
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 323

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



228
229
230
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 228

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/groupdocs_signature_cloud/models/search_barcode_options.rb', line 161

def valid?
  return false if @signature_type.nil?
  signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
  return false unless signature_type_validator.valid?(@signature_type)
  return false if @all_pages.nil?
  return false if @match_type.nil?
  match_type_validator = EnumAttributeValidator.new('String', ["Exact", "StartsWith", "EndsWith", "Contains"])
  return false unless match_type_validator.valid?(@match_type)
  return true
end