Class: Twilio::REST::Chat::V2::ServiceContext::UserInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 608

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 



654
655
656
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 654

def 
    @properties['account_sid']
end

#attributes ⇒ String 



666
667
668
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 666

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



639
640
641
642
643
644
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 639

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

#date_created ⇒ Time 



702
703
704
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 702

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



708
709
710
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 708

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance



733
734
735
736
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 733

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance



741
742
743
744
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 741

def fetch

    context.fetch
end

#friendly_name ⇒ String 



672
673
674
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 672

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



684
685
686
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 684

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



791
792
793
794
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 791

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

#is_notifiable ⇒ Boolean 



696
697
698
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 696

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean 



690
691
692
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 690

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String 



714
715
716
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 714

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash 



720
721
722
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 720

def links
    @properties['links']
end

#role_sid ⇒ String 



678
679
680
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 678

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String 



660
661
662
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 660

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



648
649
650
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 648

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



784
785
786
787
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 784

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

#update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Update the UserInstance



753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 753

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 



726
727
728
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 726

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings



778
779
780
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 778

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels



771
772
773
 
# File 'lib/twilio-ruby/rest/chat/v2/service/user.rb', line 771

def user_channels
    context.user_channels
end