class AsposeSlidesCloud::NotesSlideHeaderFooter

Represents header/footer info of notes slide

Attributes

date_time_text[RW]

Text to be displayed as date in the footer

header_text[RW]

Text to be displayed in the header

is_date_time_visible[RW]

True if date is displayed in the footer

is_header_visible[RW]

True if header is displayed

is_slide_number_visible[RW]

True if slide number is displayed in the footer

Public Class Methods

attribute_map() click to toggle source

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

Calls superclass method
# File lib/aspose_slides_cloud/models/notes_slide_header_footer.rb, line 50
def self.attribute_map
  super.merge({
    :'is_date_time_visible' => :'IsDateTimeVisible',
    :'date_time_text' => :'DateTimeText',
    :'is_footer_visible' => :'IsFooterVisible',
    :'footer_text' => :'FooterText',
    :'is_header_visible' => :'IsHeaderVisible',
    :'header_text' => :'HeaderText',
    :'is_slide_number_visible' => :'IsSlideNumberVisible',
  })
end
new(attributes = {}) click to toggle source

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

Calls superclass method
# File lib/aspose_slides_cloud/models/notes_slide_header_footer.rb, line 77
def initialize(attributes = {})
  super

  if attributes.has_key?(:'IsDateTimeVisible')
    self.is_date_time_visible = attributes[:'IsDateTimeVisible']
  end

  if attributes.has_key?(:'DateTimeText')
    self.date_time_text = attributes[:'DateTimeText']
  end

  if attributes.has_key?(:'IsFooterVisible')
    self.is_footer_visible = attributes[:'IsFooterVisible']
  end

  if attributes.has_key?(:'FooterText')
    self.footer_text = attributes[:'FooterText']
  end

  if attributes.has_key?(:'IsHeaderVisible')
    self.is_header_visible = attributes[:'IsHeaderVisible']
  end

  if attributes.has_key?(:'HeaderText')
    self.header_text = attributes[:'HeaderText']
  end

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

Attribute type mapping.

Calls superclass method
# File lib/aspose_slides_cloud/models/notes_slide_header_footer.rb, line 63
def self.swagger_types
  super.merge({
    :'is_date_time_visible' => :'BOOLEAN',
    :'date_time_text' => :'String',
    :'is_footer_visible' => :'BOOLEAN',
    :'footer_text' => :'String',
    :'is_header_visible' => :'BOOLEAN',
    :'header_text' => :'String',
    :'is_slide_number_visible' => :'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/notes_slide_header_footer.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      is_date_time_visible == o.is_date_time_visible &&
      date_time_text == o.date_time_text &&
      is_footer_visible == o.is_footer_visible &&
      footer_text == o.footer_text &&
      is_header_visible == o.is_header_visible &&
      header_text == o.header_text &&
      is_slide_number_visible == o.is_slide_number_visible
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/notes_slide_header_footer.rb, line 187
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/notes_slide_header_footer.rb, line 257
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/notes_slide_header_footer.rb, line 154
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/notes_slide_header_footer.rb, line 141
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/notes_slide_header_footer.rb, line 147
def hash
  [self_uri, alternate_links, is_date_time_visible, date_time_text, is_footer_visible, footer_text, is_header_visible, header_text, is_slide_number_visible].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

Calls superclass method
# File lib/aspose_slides_cloud/models/notes_slide_header_footer.rb, line 111
def list_invalid_properties
  invalid_properties = super
  invalid_properties
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/notes_slide_header_footer.rb, line 237
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/notes_slide_header_footer.rb, line 243
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/notes_slide_header_footer.rb, line 231
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
# File lib/aspose_slides_cloud/models/notes_slide_header_footer.rb, line 118
def valid?
  return false if !super
  true
end