Class: GroupDocsEditorCloud::SpreadsheetSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb

Overview

Allows to specify custom options for generating and saving Spreadsheet (Excel-compliant) documents

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpreadsheetSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 109

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

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'HtmlPath')
    self.html_path = attributes[:'HtmlPath']
  end

  if attributes.key?(:'ResourcesPath')
    self.resources_path = attributes[:'ResourcesPath']
  end

  if attributes.key?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.key?(:'ProtectionType')
    self.protection_type = attributes[:'ProtectionType']
  end

  if attributes.key?(:'ProtectionPassword')
    self.protection_password = attributes[:'ProtectionPassword']
  end

end

Instance Attribute Details

#file_info ⇒ Object

File info



35
36
37
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 35

def file_info
  @file_info
end

#format ⇒ Object

Document format



47
48
49
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 47

def format
  @format
end

#html_path ⇒ Object

The Html document path



41
42
43
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 41

def html_path
  @html_path
end

#output_path ⇒ Object

The full output path



38
39
40
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 38

def output_path
  @output_path
end

#password ⇒ Object

Allows to specify document password



50
51
52
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 50

def password
  @password
end

#protection_password ⇒ Object

Write-protection password. Used when protection type is specified.



56
57
58
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 56

def protection_password
  @protection_password
end

#protection_type ⇒ Object

Write-protection type. Default value is None.



53
54
55
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 53

def protection_type
  @protection_type
end

#resources_path ⇒ Object

Resources path



44
45
46
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 44

def resources_path
  @resources_path
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 80

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'OutputPath',
    :'html_path' => :'HtmlPath',
    :'resources_path' => :'ResourcesPath',
    :'format' => :'Format',
    :'password' => :'Password',
    :'protection_type' => :'ProtectionType',
    :'protection_password' => :'ProtectionPassword'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 94

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'String',
    :'html_path' => :'String',
    :'resources_path' => :'String',
    :'format' => :'String',
    :'password' => :'String',
    :'protection_type' => :'String',
    :'protection_password' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 185

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      output_path == other.output_path &&
      html_path == other.html_path &&
      resources_path == other.resources_path &&
      format == other.format &&
      password == other.password &&
      protection_type == other.protection_type &&
      protection_password == other.protection_password
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 243

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 = GroupDocsEditorCloud.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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 310

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 219

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


200
201
202
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 200

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 206

def hash
  [file_info, output_path, html_path, resources_path, format, password, protection_type, protection_password].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



151
152
153
154
155
156
157
158
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 151

def list_invalid_properties
  invalid_properties = []
  if @protection_type.nil?
    invalid_properties.push("invalid value for 'protection_type', protection_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



290
291
292
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 290

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



296
297
298
299
300
301
302
303
304
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 296

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



284
285
286
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 284

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



212
213
214
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 212

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



162
163
164
165
166
167
 
# File 'lib/groupdocs_editor_cloud/models/spreadsheet_save_options.rb', line 162

def valid?
  return false if @protection_type.nil?
  protection_type_validator = EnumAttributeValidator.new('String', ["None", "All", "Contents", "Objects", "Scenarios", "Structure", "Window"])
  return false unless protection_type_validator.valid?(@protection_type)
  return true
end