class PureCloud::ContentActions

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

Attributes

command_name[RW]

Execute an organization's specific command

context[RW]

Additional context for the command

textback[RW]

Text to be sent back in reply when a list item is selected

url[RW]

A URL for a web page to redirect the user to

url_target[RW]

The target window or tab within the URL's web page. If empty will open a blank page or tab.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/content_actions.rb, line 38
def self.attribute_map
  {
    
    :'url' => :'url',
    
    :'url_target' => :'urlTarget',
    
    :'textback' => :'textback',
    
    :'command_name' => :'commandName',
    
    :'context' => :'context'
    
  }
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_actions.rb, line 73
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?(:'url')
    
    
    self.url = attributes[:'url']
    
  
  end

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/content_actions.rb, line 55
def self.swagger_types
  {
    
    :'url' => :'String',
    
    :'url_target' => :'String',
    
    :'textback' => :'String',
    
    :'command_name' => :'String',
    
    :'context' => :'Hash<String, Object>'
    
  }
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_actions.rb, line 192
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      url_target == o.url_target &&
      textback == o.textback &&
      command_name == o.command_name &&
      context == o.context
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/content_actions.rb, line 234
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_actions.rb, line 294
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_actions.rb, line 215
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_actions.rb, line 204
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_actions.rb, line 210
def hash
  [url, url_target, textback, command_name, context].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_actions.rb, line 131
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/content_actions.rb, line 277
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_actions.rb, line 282
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_actions.rb, line 272
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_actions.rb, line 140
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end