Class: Twilio::REST::Chat::V2::ServiceContext::ChannelInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance

Initialize the ChannelInstance



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 399

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'].to_i,
      'messages_count' => payload['messages_count'].to_i,
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String 



444
445
446
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 444

def 
  @properties['account_sid']
end

#attributes ⇒ String 



468
469
470
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 468

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



429
430
431
432
433
434
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 429

def context
  unless @instance_context
    @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'], )
  end
  @instance_context
end

#created_by ⇒ String 



492
493
494
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 492

def created_by
  @properties['created_by']
end

#date_created ⇒ Time 



480
481
482
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 480

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



486
487
488
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 486

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ChannelInstance



530
531
532
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 530

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch a ChannelInstance



523
524
525
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 523

def fetch
  context.fetch
end

#friendly_name ⇒ String 



456
457
458
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 456

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



601
602
603
604
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 601

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.V2.ChannelInstance #{values}>"
end

#invites ⇒ invites

Access the invites



581
582
583
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 581

def invites
  context.invites
end

#links ⇒ String 



516
517
518
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 516

def links
  @properties['links']
end

#members ⇒ members

Access the members



567
568
569
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 567

def members
  context.members
end

#members_count ⇒ String 



498
499
500
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 498

def members_count
  @properties['members_count']
end

#messages ⇒ messages

Access the messages



574
575
576
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 574

def messages
  context.messages
end

#messages_count ⇒ String 



504
505
506
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 504

def messages_count
  @properties['messages_count']
end

#service_sid ⇒ String 



450
451
452
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 450

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



438
439
440
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 438

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



594
595
596
597
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 594

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Chat.V2.ChannelInstance #{values}>"
end

#type ⇒ channel.ChannelType 



474
475
476
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 474

def type
  @properties['type']
end

#unique_name ⇒ String 



462
463
464
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 462

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset) ⇒ ChannelInstance

Update the ChannelInstance



553
554
555
556
557
558
559
560
561
562
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 553

def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
  context.update(
      friendly_name: friendly_name,
      unique_name: unique_name,
      attributes: attributes,
      date_created: date_created,
      date_updated: date_updated,
      created_by: created_by,
  )
end

#url ⇒ String 



510
511
512
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 510

def url
  @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks



588
589
590
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 588

def webhooks
  context.webhooks
end