Class: PureCloud::UserPresenceRule
- Inherits:
-
Object
- Object
- PureCloud::UserPresenceRule
- Defined in:
- lib/purecloudplatformclientv2/models/user_presence_rule.rb
Instance Attribute Summary collapse
-
#alert_types ⇒ Object
A collection of notification methods.
-
#enabled ⇒ Object
Indicates if the rule is enabled.
-
#id ⇒ Object
The globally unique identifier for the object.
-
#in_alarm ⇒ Object
Indicates if the rule is in alarm state.
-
#name ⇒ Object
Name of the rule.
-
#notification_users ⇒ Object
The ids of users who will be notified of alarm state change.
-
#presence_limit_in_seconds ⇒ Object
The number of seconds to wait before alerting based upon the user’s presence.
-
#presence_type ⇒ Object
Indicates to which presence type the presence value belongs.
-
#presence_user ⇒ Object
The user whose presence will be watched.
-
#presence_value ⇒ Object
The Org’s UUID or Systems enum constance indicating the presence of concern.
-
#self_uri ⇒ Object
The URI for this object.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
- #_deserialize(type, value) ⇒ Object
-
#_to_hash(value) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
build the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserPresenceRule
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility)).
-
#to_hash ⇒ Object
return the object in the form of hash.
- #to_s ⇒ Object
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ UserPresenceRule
Initializes the object
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 90 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'presenceUser') self.presence_user = attributes[:'presenceUser'] end if attributes.has_key?(:'presenceType') self.presence_type = attributes[:'presenceType'] end if attributes.has_key?(:'presenceValue') self.presence_value = attributes[:'presenceValue'] end if attributes.has_key?(:'presenceLimitInSeconds') self.presence_limit_in_seconds = attributes[:'presenceLimitInSeconds'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end if attributes.has_key?(:'inAlarm') self.in_alarm = attributes[:'inAlarm'] end if attributes.has_key?(:'notificationUsers') if (value = attributes[:'notificationUsers']).is_a?(Array) self.notification_users = value end end if attributes.has_key?(:'alertTypes') if (value = attributes[:'alertTypes']).is_a?(Array) self.alert_types = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end |
Instance Attribute Details
#alert_types ⇒ Object
A collection of notification methods.
49 50 51 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 49 def alert_types @alert_types end |
#enabled ⇒ Object
Indicates if the rule is enabled.
40 41 42 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 40 def enabled @enabled end |
#id ⇒ Object
The globally unique identifier for the object.
22 23 24 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 22 def id @id end |
#in_alarm ⇒ Object
Indicates if the rule is in alarm state.
43 44 45 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 43 def in_alarm @in_alarm end |
#name ⇒ Object
Name of the rule
25 26 27 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 25 def name @name end |
#notification_users ⇒ Object
The ids of users who will be notified of alarm state change.
46 47 48 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 46 def notification_users @notification_users end |
#presence_limit_in_seconds ⇒ Object
The number of seconds to wait before alerting based upon the user’s presence.
37 38 39 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 37 def presence_limit_in_seconds @presence_limit_in_seconds end |
#presence_type ⇒ Object
Indicates to which presence type the presence value belongs.
31 32 33 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 31 def presence_type @presence_type end |
#presence_user ⇒ Object
The user whose presence will be watched.
28 29 30 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 28 def presence_user @presence_user end |
#presence_value ⇒ Object
The Org’s UUID or Systems enum constance indicating the presence of concern.
34 35 36 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 34 def presence_value @presence_value end |
#self_uri ⇒ Object
The URI for this object
52 53 54 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 52 def self_uri @self_uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/purecloudplatformclientv2/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 |
.swagger_types ⇒ Object
Attribute type mapping.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 72 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 206 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 |
#_deserialize(type, value) ⇒ Object
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 254 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) ⇒ Object
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 314 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) ⇒ Object
build the object from hash
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 235 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) ⇒ Boolean
224 225 226 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 224 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
230 231 232 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 230 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
148 149 150 151 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 148 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Object
to_body is an alias to to_body (backward compatibility))
297 298 299 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 297 def to_body to_hash end |
#to_hash ⇒ Object
return the object in the form of hash
302 303 304 305 306 307 308 309 310 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 302 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 ⇒ Object
292 293 294 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 292 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/purecloudplatformclientv2/models/user_presence_rule.rb', line 155 def valid? if @name.nil? return false end if @presence_user.nil? return false end if @presence_type.nil? return false end allowed_values = ["SYSTEM", "ORGANIZATION"] if @presence_type && !allowed_values.include?(@presence_type) return false end if @presence_value.nil? return false end if @presence_limit_in_seconds.nil? return false end if @enabled.nil? return false end if @notification_users.nil? return false end if @alert_types.nil? return false end end |