Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::IpMessaging::V1::ServiceContext::ChannelInstance
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb
Instance Method Summary collapse
- #account_sid ⇒ String
- #attributes ⇒ String
-
#context ⇒ ChannelContext
Generate an instance context for the instance, the context is capable of performing various actions.
- #created_by ⇒ String
- #date_created ⇒ Time
- #date_updated ⇒ Time
-
#delete ⇒ Boolean
Delete the ChannelInstance.
-
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance.
- #friendly_name ⇒ String
-
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance
constructor
Initialize the ChannelInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#invites ⇒ invites
Access the invites.
- #links ⇒ Hash
-
#members ⇒ members
Access the members.
- #members_count ⇒ String
-
#messages ⇒ messages
Access the messages.
- #messages_count ⇒ String
- #service_sid ⇒ String
- #sid ⇒ String
-
#to_s ⇒ Object
Provide a user friendly representation.
- #type ⇒ ChannelType
- #unique_name ⇒ String
-
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance.
- #url ⇒ String
Constructor Details
#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance
Initialize the ChannelInstance
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 344 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'], 'friendly_name' => payload['friendly_name'], 'unique_name' => payload['unique_name'], 'attributes' => payload['attributes'], 'type' => payload['type'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'created_by' => payload['created_by'], 'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i, 'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i, 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'service_sid' => service_sid || @properties['service_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
389 390 391 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 389 def account_sid @properties['account_sid'] end |
#attributes ⇒ String
413 414 415 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 413 def attributes @properties['attributes'] end |
#context ⇒ ChannelContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
374 375 376 377 378 379 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 374 def context unless @instance_context @instance_context = ChannelContext.new(@version , @params['service_sid'], @params['sid']) end @instance_context end |
#created_by ⇒ String
437 438 439 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 437 def created_by @properties['created_by'] end |
#date_created ⇒ Time
425 426 427 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 425 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
431 432 433 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 431 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ChannelInstance
468 469 470 471 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 468 def delete context.delete end |
#fetch ⇒ ChannelInstance
Fetch the ChannelInstance
476 477 478 479 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 476 def fetch context.fetch end |
#friendly_name ⇒ String
401 402 403 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 401 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
530 531 532 533 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 530 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ChannelInstance #{values}>" end |
#invites ⇒ invites
Access the invites
517 518 519 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 517 def invites context.invites end |
#links ⇒ Hash
461 462 463 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 461 def links @properties['links'] end |
#members ⇒ members
Access the members
503 504 505 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 503 def members context.members end |
#members_count ⇒ String
443 444 445 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 443 def members_count @properties['members_count'] end |
#messages ⇒ messages
Access the messages
510 511 512 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 510 def context. end |
#messages_count ⇒ String
449 450 451 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 449 def @properties['messages_count'] end |
#service_sid ⇒ String
395 396 397 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 395 def service_sid @properties['service_sid'] end |
#sid ⇒ String
383 384 385 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 383 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
523 524 525 526 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 523 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ChannelInstance #{values}>" end |
#type ⇒ ChannelType
419 420 421 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 419 def type @properties['type'] end |
#unique_name ⇒ String
407 408 409 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 407 def unique_name @properties['unique_name'] end |
#update(friendly_name: :unset, unique_name: :unset, attributes: :unset) ⇒ ChannelInstance
Update the ChannelInstance
487 488 489 490 491 492 493 494 495 496 497 498 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 487 def update( friendly_name: :unset, unique_name: :unset, attributes: :unset ) context.update( friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, ) end |
#url ⇒ String
455 456 457 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 455 def url @properties['url'] end |