class PureCloud::ContentList

List content object

Attributes

actions[RW]

User actions available on the content. All actions are optional and all actions are executed simultaneously.

components[RW]

An array of component objects

description[RW]

Text to show in the description row. This is immediately below the title

id[RW]

An ID assigned to this rich message content. Each instance inside the content array has a unique ID.

list_type[RW]

The type of list this instance represents

submit_label[RW]

Label for Submit button

title[RW]

Text to show in the title row

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 44
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'list_type' => :'listType',
    
    :'title' => :'title',
    
    :'description' => :'description',
    
    :'submit_label' => :'submitLabel',
    
    :'actions' => :'actions',
    
    :'components' => :'components'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 87
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.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'listType')
    
    
    self.list_type = attributes[:'listType']
    
  
  end

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

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

  
  if attributes.has_key?(:'submitLabel')
    
    
    self.submit_label = attributes[:'submitLabel']
    
  
  end

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

  
  if attributes.has_key?(:'components')
    
    if (value = attributes[:'components']).is_a?(Array)
      self.components = value
    end
    
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/content_list.rb, line 65
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'list_type' => :'String',
    
    :'title' => :'String',
    
    :'description' => :'String',
    
    :'submit_label' => :'String',
    
    :'actions' => :'ContentActions',
    
    :'components' => :'Array<ListItemComponent>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 256
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      list_type == o.list_type &&
      title == o.title &&
      description == o.description &&
      submit_label == o.submit_label &&
      actions == o.actions &&
      components == o.components
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/content_list.rb, line 300
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/content_list.rb, line 360
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

build the object from hash

# File lib/purecloudplatformclientv2/models/content_list.rb, line 281
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 270
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 276
def hash
  [id, list_type, title, description, submit_label, actions, components].hash
end
list_invalid_properties() click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 163
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
list_type=(list_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 218
def list_type=(list_type)
  allowed_values = ["Selection", "Vertical"]
  if list_type && !allowed_values.include?(list_type)
    fail ArgumentError, "invalid value for 'list_type', must be one of #{allowed_values}."
  end
  @list_type = list_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/content_list.rb, line 343
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/content_list.rb, line 348
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
# File lib/purecloudplatformclientv2/models/content_list.rb, line 338
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

# File lib/purecloudplatformclientv2/models/content_list.rb, line 172
def valid?
  
  
  
  
  
  
  
  allowed_values = ["Selection", "Vertical"]
  if @list_type && !allowed_values.include?(@list_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end