Class: Twilio::REST::IpMessaging::V1::ServiceContext::UserInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this User resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 580

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

Returns:

  • (String) 


626
627
628
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 626

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


638
639
640
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 638

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

Returns:



611
612
613
614
615
616
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 611

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

#date_created ⇒ Time

Returns:

  • (Time) 


674
675
676
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 674

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


680
681
682
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 680

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



713
714
715
716
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 713

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


644
645
646
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 644

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns:

  • (String) 


656
657
658
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 656

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



753
754
755
756
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 753

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

#is_notifiable ⇒ Boolean

Returns:

  • (Boolean) 


668
669
670
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 668

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns:

  • (Boolean) 


662
663
664
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 662

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String

Returns:

  • (String) 


686
687
688
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 686

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

Returns:

  • (Hash) 


692
693
694
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 692

def links
    @properties['links']
end

#role_sid ⇒ String

Returns:

  • (String) 


650
651
652
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 650

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


632
633
634
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 632

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


620
621
622
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 620

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

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

Update the UserInstance

Parameters:

  • role_sid (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)

Returns:



724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 724

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

Returns:

  • (String) 


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

def url
    @properties['url']
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



740
741
742
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb', line 740

def user_channels
    context.user_channels
end