class AsposeSlidesCloud::SlideShowProperties

Slide show properties.

Attributes

end_slide[RW]

End slides in the slide show.

loop[RW]

Loop slide show.

pen_color[RW]

Pen color.

show_animation[RW]

Show animation.

show_media_controls[RW]

Show media controls.

show_narration[RW]

Show narrration.

show_scrollbar[RW]

Show scroll bar. Applied with BrowsedByIndividual slide show type.

slide_show_type[RW]

Slide show type.

start_slide[RW]

Start slide in the slide show.

use_timings[RW]

Use timings.

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_show_properties.rb, line 59
def self.attribute_map
  super.merge({
    :'loop' => :'Loop',
    :'start_slide' => :'StartSlide',
    :'end_slide' => :'EndSlide',
    :'pen_color' => :'PenColor',
    :'show_animation' => :'ShowAnimation',
    :'show_narration' => :'ShowNarration',
    :'show_media_controls' => :'ShowMediaControls',
    :'use_timings' => :'UseTimings',
    :'slide_show_type' => :'SlideShowType',
    :'show_scrollbar' => :'ShowScrollbar',
  })
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_show_properties.rb, line 92
def initialize(attributes = {})
  super

  if attributes.has_key?(:'Loop')
    self.loop = attributes[:'Loop']
  end

  if attributes.has_key?(:'StartSlide')
    self.start_slide = attributes[:'StartSlide']
  end

  if attributes.has_key?(:'EndSlide')
    self.end_slide = attributes[:'EndSlide']
  end

  if attributes.has_key?(:'PenColor')
    self.pen_color = attributes[:'PenColor']
  end

  if attributes.has_key?(:'ShowAnimation')
    self.show_animation = attributes[:'ShowAnimation']
  end

  if attributes.has_key?(:'ShowNarration')
    self.show_narration = attributes[:'ShowNarration']
  end

  if attributes.has_key?(:'ShowMediaControls')
    self.show_media_controls = attributes[:'ShowMediaControls']
  end

  if attributes.has_key?(:'UseTimings')
    self.use_timings = attributes[:'UseTimings']
  end

  if attributes.has_key?(:'SlideShowType')
    self.slide_show_type = attributes[:'SlideShowType']
  end

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

Attribute type mapping.

# File lib/aspose_slides_cloud/models/slide_show_properties.rb, line 75
def self.swagger_types
  super.merge({
    :'loop' => :'BOOLEAN',
    :'start_slide' => :'Integer',
    :'end_slide' => :'Integer',
    :'pen_color' => :'String',
    :'show_animation' => :'BOOLEAN',
    :'show_narration' => :'BOOLEAN',
    :'show_media_controls' => :'BOOLEAN',
    :'use_timings' => :'BOOLEAN',
    :'slide_show_type' => :'String',
    :'show_scrollbar' => :'BOOLEAN',
  })
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_show_properties.rb, line 164
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      loop == o.loop &&
      start_slide == o.start_slide &&
      end_slide == o.end_slide &&
      pen_color == o.pen_color &&
      show_animation == o.show_animation &&
      show_narration == o.show_narration &&
      show_media_controls == o.show_media_controls &&
      use_timings == o.use_timings &&
      slide_show_type == o.slide_show_type &&
      show_scrollbar == o.show_scrollbar
end
eql?(o) click to toggle source

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

# File lib/aspose_slides_cloud/models/slide_show_properties.rb, line 183
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_show_properties.rb, line 189
def hash
  [self_uri, alternate_links, loop, start_slide, end_slide, pen_color, show_animation, show_narration, show_media_controls, use_timings, slide_show_type, show_scrollbar].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_show_properties.rb, line 138
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
slide_show_type=(slide_show_type) click to toggle source

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

# File lib/aspose_slides_cloud/models/slide_show_properties.rb, line 154
def slide_show_type=(slide_show_type)
  validator = EnumAttributeValidator.new('String', ['BrowsedAtKiosk', 'BrowsedByIndividual', 'PresentedBySpeaker'])
  unless validator.valid?(slide_show_type)
    fail ArgumentError, 'invalid value for "slide_show_type", must be one of #{validator.allowable_values}.'
  end
  @slide_show_type = slide_show_type
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_show_properties.rb, line 145
def valid?
  return false if !super
  slide_show_type_validator = EnumAttributeValidator.new('String', ['BrowsedAtKiosk', 'BrowsedByIndividual', 'PresentedBySpeaker'])
  return false unless slide_show_type_validator.valid?(@slide_show_type)
  true
end