class PureCloud::UserPresenceRule
Attributes
A collection of notification methods.
Indicates if the rule is enabled.
The globally unique identifier for the object.
Indicates if the rule is in alarm state.
Name of the rule
The ids of users who will be notified of alarm state change.
The number of seconds to wait before alerting based upon the user's presence.
Indicates to which presence type the presence value belongs.
The user whose presence will be watched.
The Org's UUID or Systems enum constance indicating the presence of concern.
The URI for this object
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/user_presence_rule.rb, line 55 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'presence_user' => :'presenceUser', :'presence_type' => :'presenceType', :'presence_value' => :'presenceValue', :'presence_limit_in_seconds' => :'presenceLimitInSeconds', :'enabled' => :'enabled', :'in_alarm' => :'inAlarm', :'notification_users' => :'notificationUsers', :'alert_types' => :'alertTypes', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/user_presence_rule.rb, line 101 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[:'enabled'] self.enabled = attributes[:'enabled'] end if attributes[:'inAlarm'] self.in_alarm = attributes[:'inAlarm'] 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[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/user_presence_rule.rb, line 84 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'presence_user' => :'User', :'presence_type' => :'String', :'presence_value' => :'String', :'presence_limit_in_seconds' => :'Integer', :'enabled' => :'BOOLEAN', :'in_alarm' => :'BOOLEAN', :'notification_users' => :'Array<User>', :'alert_types' => :'Array<String>', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/user_presence_rule.rb, line 168 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 && enabled == o.enabled && in_alarm == o.in_alarm && notification_users == o.notification_users && alert_types == o.alert_types && self_uri == o.self_uri end
# File lib/purecloud/models/user_presence_rule.rb, line 214 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
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_rule.rb, line 274 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 the object from hash
# File lib/purecloud/models/user_presence_rule.rb, line 195 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
@see the `==` method
# File lib/purecloud/models/user_presence_rule.rb, line 185 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/user_presence_rule.rb, line 190 def hash [id, name, presence_user, presence_type, presence_value, presence_limit_in_seconds, enabled, in_alarm, notification_users, alert_types, self_uri].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/user_presence_rule.rb, line 159 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
return the object in the form of hash
# File lib/purecloud/models/user_presence_rule.rb, line 262 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
# File lib/purecloud/models/user_presence_rule.rb, line 252 def to_s to_hash.to_s end