Class: GroupDocsConversionCloud::WebLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/web_load_options.rb

Overview

Html document load options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 58

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

  if attributes.key?(:'PageNumbering')
    self.page_numbering = attributes[:'PageNumbering']
  end

end

Instance Attribute Details

#formatObject

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 35

def format
  @format
end

#page_numberingObject

Enable or disable generation of page numbering in converted document. Default: false



38
39
40
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 38

def page_numbering
  @page_numbering
end

Class Method Details

.attribute_mapObject

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



41
42
43
44
45
46
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 41

def self.attribute_map
  {
    :'format' => :'Format',
    :'page_numbering' => :'PageNumbering'
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 49

def self.swagger_types
  {
    :'format' => :'String',
    :'page_numbering' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



94
95
96
97
98
99
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 94

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      page_numbering == other.page_numbering
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 146

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



213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 213

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 122

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


103
104
105
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 103

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



109
110
111
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 109

def hash
  [format, page_numbering].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



76
77
78
79
80
81
82
83
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 76

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



193
194
195
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 193

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 199

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



187
188
189
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 187

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



115
116
117
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 115

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



87
88
89
90
# File 'lib/groupdocs_conversion_cloud/models/web_load_options.rb', line 87

def valid?
  return false if @page_numbering.nil?
  return true
end