Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelContext::InteractionChannelParticipantInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, interaction_sid: nil, channel_sid: nil, sid: nil) ⇒ InteractionChannelParticipantInstance

Initialize the InteractionChannelParticipantInstance

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 InteractionChannelParticipant resource.

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

    The SID of the Call resource to fetch.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 470

def initialize(version, payload , interaction_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'type' => payload['type'],
        'interaction_sid' => payload['interaction_sid'],
        'channel_sid' => payload['channel_sid'],
        'url' => payload['url'],
        'routing_properties' => payload['routing_properties'],
    }

    # Context
    @instance_context = nil
    @params = { 'interaction_sid' => interaction_sid  || @properties['interaction_sid']  ,'channel_sid' => channel_sid  || @properties['channel_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#channel_sid ⇒ String

Returns The Channel Sid for this Participant.

Returns:

  • (String) —

    The Channel Sid for this Participant.



520
521
522
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 520

def channel_sid
    @properties['channel_sid']
end

#context ⇒ InteractionChannelParticipantContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



493
494
495
496
497
498
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 493

def context
    unless @instance_context
        @instance_context = InteractionChannelParticipantContext.new(@version , @params['interaction_sid'], @params['channel_sid'], @params['sid'])
    end
    @instance_context
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



558
559
560
561
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 558

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

#interaction_sid ⇒ String

Returns The Interaction Sid for this channel.

Returns:

  • (String) —

    The Interaction Sid for this channel.



514
515
516
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 514

def interaction_sid
    @properties['interaction_sid']
end

#routing_properties ⇒ Hash

Returns The Participant’s routing properties.

Returns:

  • (Hash) —

    The Participant’s routing properties.



532
533
534
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 532

def routing_properties
    @properties['routing_properties']
end

#sid ⇒ String

Returns The unique string created by Twilio to identify an Interaction Channel Participant resource.

Returns:

  • (String) —

    The unique string created by Twilio to identify an Interaction Channel Participant resource.



502
503
504
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 502

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



551
552
553
554
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 551

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

#type ⇒ Type

Returns:

  • (Type) 


508
509
510
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 508

def type
    @properties['type']
end

#update(status: nil) ⇒ InteractionChannelParticipantInstance

Update the InteractionChannelParticipantInstance

Parameters:

  • status (Status) (defaults to: nil)

Returns:



540
541
542
543
544
545
546
547
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 540

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns:

  • (String) 


526
527
528
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 526

def url
    @properties['url']
end