Class: AsposeSlidesCloud::SaveSlide

Inherits:
Task
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/save_slide.rb

Overview

Save slide task.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from Task

#type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaveSlide

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 94

def initialize(attributes = {})
  super

  if attributes.has_key?(:'Output')
    self.output = attributes[:'Output']
  end

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

  if attributes.has_key?(:'Options')
    self.options = attributes[:'Options']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.has_key?(:'Position')
    self.position = attributes[:'Position']
  end
  self.type = 'SaveSlide'
end

Instance Attribute Details

#format ⇒ Object

Save format.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 32

def format
  @format
end

#height ⇒ Object

Result height for saving to an image format.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 41

def height
  @height
end

#options ⇒ Object

Save options.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 35

def options
  @options
end

#output ⇒ Object

Output to save the slide to.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 29

def output
  @output
end

#position ⇒ Object

Slide index.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 44

def position
  @position
end

#width ⇒ Object

Result width for saving to an image format.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 38

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 69

def self.attribute_map
  super.merge({
    :'output' => :'Output',
    :'format' => :'Format',
    :'options' => :'Options',
    :'width' => :'Width',
    :'height' => :'Height',
    :'position' => :'Position',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 81

def self.swagger_types
  super.merge({
    :'output' => :'OutputFile',
    :'format' => :'String',
    :'options' => :'ExportOptions',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'position' => :'Integer',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      output == o.output &&
      format == o.format &&
      options == o.options &&
      width == o.width &&
      height == o.height &&
      position == o.position
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



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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 221

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 295

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


175
176
177
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 181

def hash
  [type, output, format, options, width, height, position].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 125

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

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

  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



275
276
277
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 281

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



269
270
271
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 269

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



140
141
142
143
144
145
146
147
 
# File 'lib/aspose_slides_cloud/models/save_slide.rb', line 140

def valid?
  return false if !super
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new('String', ['Jpeg', 'Png', 'Gif', 'Bmp', 'Tiff', 'Html', 'Pdf', 'Xps', 'Pptx', 'Odp', 'Otp', 'Ppt', 'Pps', 'Ppsx', 'Pptm', 'Ppsm', 'Potx', 'Pot', 'Potm', 'Svg', 'Fodp', 'Xaml', 'Html5'])
  return false unless format_validator.valid?(@format)
  return false if @position.nil?
  true
end