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
- #attributes ⇒ String
-
#context ⇒ UserContext
Generate an instance context for the instance, the context is capable of performing various actions.
- #date_created ⇒ Time
- #date_updated ⇒ Time
-
#delete ⇒ Boolean
Delete the UserInstance.
-
#fetch ⇒ UserInstance
Fetch the UserInstance.
- #friendly_name ⇒ String
- #identity ⇒ String
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ UserInstance
constructor
Initialize the UserInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #is_notifiable ⇒ Boolean
- #is_online ⇒ Boolean
- #joined_channels_count ⇒ String
- #links ⇒ Hash
- #role_sid ⇒ String
- #service_sid ⇒ String
- #sid ⇒ String
-
#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
-
#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
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 346 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'] == nil ? payload['joined_channels_count'] : payload['joined_channels_count'].to_i, 'links' => payload['links'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
391 392 393 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 391 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
403 404 405 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 403 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
376 377 378 379 380 381 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 376 def context unless @instance_context @instance_context = UserContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
439 440 441 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 439 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
445 446 447 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 445 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the UserInstance
470 471 472 473 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 470 def delete context.delete end |
#fetch ⇒ UserInstance
Fetch the UserInstance
478 479 480 481 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 478 def fetch context.fetch end |
#friendly_name ⇒ String
409 410 411 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 409 def friendly_name @properties['friendly_name'] end |
#identity ⇒ String
421 422 423 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 421 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
528 529 530 531 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 528 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V2.UserInstance #{values}>" end |
#is_notifiable ⇒ Boolean
433 434 435 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 433 def is_notifiable @properties['is_notifiable'] end |
#is_online ⇒ Boolean
427 428 429 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 427 def is_online @properties['is_online'] end |
#joined_channels_count ⇒ String
451 452 453 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 451 def joined_channels_count @properties['joined_channels_count'] end |
#links ⇒ Hash
457 458 459 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 457 def links @properties['links'] end |
#role_sid ⇒ String
415 416 417 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 415 def role_sid @properties['role_sid'] end |
#service_sid ⇒ String
397 398 399 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 397 def service_sid @properties['service_sid'] end |
#sid ⇒ String
385 386 387 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 385 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
521 522 523 524 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 521 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
490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 490 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
463 464 465 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 463 def url @properties['url'] end |
#user_bindings ⇒ user_bindings
Access the user_bindings
515 516 517 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 515 def user_bindings context.user_bindings end |
#user_channels ⇒ user_channels
Access the user_channels
508 509 510 |
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 508 def user_channels context.user_channels end |