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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 392

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 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

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



422
423
424
425
426
427
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 422

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

#created_by ⇒ String 



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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ChannelInstance



517
518
519
520
521
522
523
524
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 517

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#invites ⇒ invites

Access the invites



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

def invites
    context.invites
end

#links ⇒ Hash 



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

def links
    @properties['links']
end

#members ⇒ members

Access the members



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

def members
    context.members
end

#members_count ⇒ String 



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

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages



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

def messages
    context.messages
end

#messages_count ⇒ String 



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

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String 



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ ChannelType 



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

def type
    @properties['type']
end

#unique_name ⇒ String 



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

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, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 544

def update(
    friendly_name: :unset, 
    unique_name: :unset, 
    attributes: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    created_by: :unset, 
    x_twilio_webhook_enabled: :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, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks



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

def webhooks
    context.webhooks
end