class PureCloud::UserPresenceAlert

Attributes

alert_types[RW]

A collection of notification methods.

end_date[RW]

The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

id[RW]

The globally unique identifier for the object.

name[RW]

Name of the rule

notification_users[RW]

The ids of users who were notified of alarm state change.

presence_limit_in_seconds[RW]

The number of seconds to wait before alerting based upon the user's presence.

presence_type[RW]

Indicates to which presence type the presence value belongs.

presence_user[RW]

The user whose presence will be watched.

presence_value[RW]

The Org's UUID or Systems enum constance indicating the presence of concern.

rule_id[RW]

The id of the rule.

rule_uri[RW]
self_uri[RW]

The URI for this object

start_date[RW]

The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/user_presence_alert.rb, line 60
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'presence_user' => :'presenceUser',
    
    :'presence_type' => :'presenceType',
    
    :'presence_value' => :'presenceValue',
    
    :'presence_limit_in_seconds' => :'presenceLimitInSeconds',
    
    :'rule_id' => :'ruleId',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'notification_users' => :'notificationUsers',
    
    :'alert_types' => :'alertTypes',
    
    :'rule_uri' => :'ruleUri',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/user_presence_alert.rb, line 112
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'presenceUser']
    self.presence_user = attributes[:'presenceUser']
  end
  
  if attributes[:'presenceType']
    self.presence_type = attributes[:'presenceType']
  end
  
  if attributes[:'presenceValue']
    self.presence_value = attributes[:'presenceValue']
  end
  
  if attributes[:'presenceLimitInSeconds']
    self.presence_limit_in_seconds = attributes[:'presenceLimitInSeconds']
  end
  
  if attributes[:'ruleId']
    self.rule_id = attributes[:'ruleId']
  end
  
  if attributes[:'startDate']
    self.start_date = attributes[:'startDate']
  end
  
  if attributes[:'endDate']
    self.end_date = attributes[:'endDate']
  end
  
  if attributes[:'notificationUsers']
    if (value = attributes[:'notificationUsers']).is_a?(Array)
      self.notification_users = value
    end
  end
  
  if attributes[:'alertTypes']
    if (value = attributes[:'alertTypes']).is_a?(Array)
      self.alert_types = value
    end
  end
  
  if attributes[:'ruleUri']
    self.rule_uri = attributes[:'ruleUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/user_presence_alert.rb, line 93
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'presence_user' => :'User',
    :'presence_type' => :'String',
    :'presence_value' => :'String',
    :'presence_limit_in_seconds' => :'Integer',
    :'rule_id' => :'String',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'notification_users' => :'Array<User>',
    :'alert_types' => :'Array<String>',
    :'rule_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/user_presence_alert.rb, line 187
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      presence_user == o.presence_user &&
      presence_type == o.presence_type &&
      presence_value == o.presence_value &&
      presence_limit_in_seconds == o.presence_limit_in_seconds &&
      rule_id == o.rule_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      notification_users == o.notification_users &&
      alert_types == o.alert_types &&
      rule_uri == o.rule_uri &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/user_presence_alert.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 =~ /^(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/purecloud/models/user_presence_alert.rb, line 295
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/purecloud/models/user_presence_alert.rb, line 216
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

# File lib/purecloud/models/user_presence_alert.rb, line 206
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/user_presence_alert.rb, line 211
def hash
  [id, name, presence_user, presence_type, presence_value, presence_limit_in_seconds, rule_id, start_date, end_date, notification_users, alert_types, rule_uri, self_uri].hash
end
presence_type=(presence_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/user_presence_alert.rb, line 178
def presence_type=(presence_type)
  allowed_values = ["SYSTEM", "ORGANIZATION"]
  if presence_type && !allowed_values.include?(presence_type)
    fail "invalid value for 'presence_type', must be one of #{allowed_values}"
  end
  @presence_type = presence_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/user_presence_alert.rb, line 278
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/user_presence_alert.rb, line 283
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/purecloud/models/user_presence_alert.rb, line 273
def to_s
  to_hash.to_s
end