Class: Twilio::REST::Chat::V1::ServiceContext::ChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelInstance



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 630

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 



676
677
678
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 676

def 
    @properties['account_sid']
end

#attributes ⇒ String 



700
701
702
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 700

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



661
662
663
664
665
666
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 661

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

#created_by ⇒ String 



724
725
726
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 724

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



712
713
714
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 712

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



718
719
720
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 718

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance



755
756
757
758
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 755

def delete

    context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance



763
764
765
766
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 763

def fetch

    context.fetch
end

#friendly_name ⇒ String 



688
689
690
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 688

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



817
818
819
820
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 817

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

#invites ⇒ invites

Access the invites



804
805
806
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 804

def invites
    context.invites
end

#links ⇒ Hash 



748
749
750
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 748

def links
    @properties['links']
end

#members ⇒ members

Access the members



790
791
792
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 790

def members
    context.members
end

#members_count ⇒ String 



730
731
732
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 730

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages



797
798
799
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 797

def messages
    context.messages
end

#messages_count ⇒ String 



736
737
738
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 736

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String 



682
683
684
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 682

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



670
671
672
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 670

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



810
811
812
813
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 810

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

#type ⇒ ChannelType 



706
707
708
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 706

def type
    @properties['type']
end

#unique_name ⇒ String 



694
695
696
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 694

def unique_name
    @properties['unique_name']
end

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

Update the ChannelInstance



774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 774

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 



742
743
744
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 742

def url
    @properties['url']
end