Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::IpMessaging::V2::ServiceContext::UserInstance
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The account_sid.
-
#attributes ⇒ String
The attributes.
-
#context ⇒ UserContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date_created.
-
#date_updated ⇒ Time
The date_updated.
-
#delete ⇒ Boolean
Delete the UserInstance.
-
#fetch ⇒ UserInstance
Fetch the UserInstance.
-
#friendly_name ⇒ String
The friendly_name.
-
#identity ⇒ String
The identity.
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ UserInstance
constructor
Initialize the UserInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#is_notifiable ⇒ Boolean
The is_notifiable.
-
#is_online ⇒ Boolean
The is_online.
-
#joined_channels_count ⇒ String
The joined_channels_count.
-
#links ⇒ String
The links.
-
#role_sid ⇒ String
The role_sid.
-
#service_sid ⇒ String
The service_sid.
-
#sid ⇒ String
The sid.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Update the UserInstance.
-
#url ⇒ String
The url.
-
#user_bindings ⇒ user_bindings
Access the user_bindings.
-
#user_channels ⇒ user_channels
Access the user_channels.
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ UserInstance
Initialize the UserInstance
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 290 def initialize(version, payload, service_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'attributes' => payload['attributes'], 'friendly_name' => payload['friendly_name'], 'role_sid' => payload['role_sid'], 'identity' => payload['identity'], 'is_online' => payload['is_online'], 'is_notifiable' => payload['is_notifiable'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'joined_channels_count' => payload['joined_channels_count'].to_i, 'links' => payload['links'], 'url' => payload['url'], } # Context @instance_context = nil @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The account_sid.
335 336 337 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 335 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
Returns The attributes.
347 348 349 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 347 def attributes @properties['attributes'] end |
#context ⇒ UserContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
320 321 322 323 324 325 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 320 def context unless @instance_context @instance_context = UserContext.new(@version, @params['service_sid'], @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The date_created.
383 384 385 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 383 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date_updated.
389 390 391 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 389 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the UserInstance
421 422 423 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 421 def delete context.delete end |
#fetch ⇒ UserInstance
Fetch the UserInstance
414 415 416 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 414 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The friendly_name.
353 354 355 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 353 def friendly_name @properties['friendly_name'] end |
#identity ⇒ String
Returns The identity.
365 366 367 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 365 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
465 466 467 468 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 465 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V2.UserInstance #{values}>" end |
#is_notifiable ⇒ Boolean
Returns The is_notifiable.
377 378 379 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 377 def is_notifiable @properties['is_notifiable'] end |
#is_online ⇒ Boolean
Returns The is_online.
371 372 373 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 371 def is_online @properties['is_online'] end |
#joined_channels_count ⇒ String
Returns The joined_channels_count.
395 396 397 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 395 def joined_channels_count @properties['joined_channels_count'] end |
#links ⇒ String
Returns The links.
401 402 403 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 401 def links @properties['links'] end |
#role_sid ⇒ String
Returns The role_sid.
359 360 361 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 359 def role_sid @properties['role_sid'] end |
#service_sid ⇒ String
Returns The service_sid.
341 342 343 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 341 def service_sid @properties['service_sid'] end |
#sid ⇒ String
Returns The sid.
329 330 331 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 329 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
458 459 460 461 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 458 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V2.UserInstance #{values}>" end |
#update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance
Update the UserInstance
433 434 435 436 437 438 439 440 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 433 def update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) context.update( role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#url ⇒ String
Returns The url.
407 408 409 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 407 def url @properties['url'] end |
#user_bindings ⇒ user_bindings
Access the user_bindings
452 453 454 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 452 def user_bindings context.user_bindings end |
#user_channels ⇒ user_channels
Access the user_channels
445 446 447 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 445 def user_channels context.user_channels end |