Class: Twilio::REST::Chat::V1::ServiceContext::UserInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 572

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 



618
619
620
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 618

def 
    @properties['account_sid']
end

#attributes ⇒ String 



630
631
632
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 630

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



603
604
605
606
607
608
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 603

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance



697
698
699
700
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 697

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



636
637
638
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 636

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



745
746
747
748
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 745

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

#is_notifiable ⇒ Boolean 



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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean 



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

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String 



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

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash 



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

def links
    @properties['links']
end

#role_sid ⇒ String 



642
643
644
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 642

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String 



624
625
626
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 624

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



612
613
614
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 612

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



738
739
740
741
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 738

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

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

Update the UserInstance



716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 716

def update(
    role_sid: :unset, 
    attributes: :unset, 
    friendly_name: :unset
)

    context.update(
        role_sid: role_sid, 
        attributes: attributes, 
        friendly_name: friendly_name, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels



732
733
734
 
# File 'lib/twilio-ruby/rest/chat/v1/service/user.rb', line 732

def user_channels
    context.user_channels
end