class AsposeSlidesCloud::SlideProperties

Slide properties.

Attributes

first_slide_number[RW]

First slide number.

height[RW]

Height.

orientation[RW]

Slide orientation.

scale_type[RW]

Scale type.

size_type[RW]

Size type.

width[RW]

Width.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 69
def self.attribute_map
  super.merge({
    :'first_slide_number' => :'FirstSlideNumber',
    :'orientation' => :'Orientation',
    :'scale_type' => :'ScaleType',
    :'size_type' => :'SizeType',
    :'width' => :'Width',
    :'height' => :'Height',
  })
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Calls superclass method AsposeSlidesCloud::ResourceBase::new
# File lib/aspose_slides_cloud/models/slide_properties.rb, line 94
def initialize(attributes = {})
  super

  if attributes.has_key?(:'FirstSlideNumber')
    self.first_slide_number = attributes[:'FirstSlideNumber']
  end

  if attributes.has_key?(:'Orientation')
    self.orientation = attributes[:'Orientation']
  end

  if attributes.has_key?(:'ScaleType')
    self.scale_type = attributes[:'ScaleType']
  end

  if attributes.has_key?(:'SizeType')
    self.size_type = attributes[:'SizeType']
  end

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

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 81
def self.swagger_types
  super.merge({
    :'first_slide_number' => :'Integer',
    :'orientation' => :'String',
    :'scale_type' => :'String',
    :'size_type' => :'String',
    :'width' => :'Integer',
    :'height' => :'Integer',
  })
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 174
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      first_slide_number == o.first_slide_number &&
      orientation == o.orientation &&
      scale_type == o.scale_type &&
      size_type == o.size_type &&
      width == o.width &&
      height == o.height
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 235
def _deserialize(type, value)
  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
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 305
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 202
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 189
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 195
def hash
  [self_uri, alternate_links, first_slide_number, orientation, scale_type, size_type, width, height].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 124
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
orientation=(orientation) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] orientation Object to be assigned

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 144
def orientation=(orientation)
  validator = EnumAttributeValidator.new('String', ['Landscape', 'Portrait'])
  unless validator.valid?(orientation)
    fail ArgumentError, 'invalid value for "orientation", must be one of #{validator.allowable_values}.'
  end
  @orientation = orientation
end
scale_type=(scale_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] scale_type Object to be assigned

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 154
def scale_type=(scale_type)
  validator = EnumAttributeValidator.new('String', ['DoNotScale', 'EnsureFit', 'Maximize'])
  unless validator.valid?(scale_type)
    fail ArgumentError, 'invalid value for "scale_type", must be one of #{validator.allowable_values}.'
  end
  @scale_type = scale_type
end
size_type=(size_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] size_type Object to be assigned

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 164
def size_type=(size_type)
  validator = EnumAttributeValidator.new('String', ['OnScreen', 'LetterPaper', 'A4Paper', 'Slide35mm', 'Overhead', 'Banner', 'Custom', 'Ledger', 'A3Paper', 'B4IsoPaper', 'B5IsoPaper', 'B4JisPaper', 'B5JisPaper', 'HagakiCard', 'OnScreen16x9', 'OnScreen16x10', 'Widescreen'])
  unless validator.valid?(size_type)
    fail ArgumentError, 'invalid value for "size_type", must be one of #{validator.allowable_values}.'
  end
  @size_type = size_type
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 285
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 291
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_slides_cloud/models/slide_properties.rb, line 279
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

Calls superclass method AsposeSlidesCloud::ResourceBase#valid?
# File lib/aspose_slides_cloud/models/slide_properties.rb, line 131
def valid?
  return false if !super
  orientation_validator = EnumAttributeValidator.new('String', ['Landscape', 'Portrait'])
  return false unless orientation_validator.valid?(@orientation)
  scale_type_validator = EnumAttributeValidator.new('String', ['DoNotScale', 'EnsureFit', 'Maximize'])
  return false unless scale_type_validator.valid?(@scale_type)
  size_type_validator = EnumAttributeValidator.new('String', ['OnScreen', 'LetterPaper', 'A4Paper', 'Slide35mm', 'Overhead', 'Banner', 'Custom', 'Ledger', 'A3Paper', 'B4IsoPaper', 'B5IsoPaper', 'B4JisPaper', 'B5JisPaper', 'HagakiCard', 'OnScreen16x9', 'OnScreen16x10', 'Widescreen'])
  return false unless size_type_validator.valid?(@size_type)
  true
end