Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the InteractionChannelInstance

Parameters:

  • Version that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this InteractionChannel resource.

  • (defaults to: nil)

    The SID of the Call resource to fetch.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 498

def initialize(version, payload , interaction_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'interaction_sid' => payload['interaction_sid'],
        'type' => payload['type'],
        'status' => payload['status'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'error_message' => payload['error_message'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#context ⇒ InteractionChannelContext

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

Returns:

  • CallContext for this CallInstance



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

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

#error_code ⇒ String

Returns The Twilio error code for a failed channel.

Returns:

  • The Twilio error code for a failed channel.



556
557
558
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 556

def error_code
    @properties['error_code']
end

#error_message ⇒ String

Returns The error message for a failed channel.

Returns:

  • The error message for a failed channel.



562
563
564
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 562

def error_message
    @properties['error_message']
end

#fetch ⇒ InteractionChannelInstance

Fetch the InteractionChannelInstance

Returns:

  • Fetched InteractionChannelInstance



581
582
583
584
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 581

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



632
633
634
635
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 632

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

#interaction_sid ⇒ String

Returns The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

Returns:

  • The unique string created by Twilio to identify an Interaction resource, prefixed with KD.



538
539
540
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 538

def interaction_sid
    @properties['interaction_sid']
end

#invites ⇒ invites

Access the invites

Returns:

  • invites



605
606
607
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 605

def invites
    context.invites
end

#links ⇒ Hash

Returns:



574
575
576
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 574

def links
    @properties['links']
end

#participants ⇒ participants

Access the participants

Returns:

  • participants



619
620
621
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 619

def participants
    context.participants
end

#sid ⇒ String

Returns The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.

Returns:

  • The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.



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

def sid
    @properties['sid']
end

#status ⇒ ChannelStatus

Returns:



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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



625
626
627
628
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 625

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

#transfers ⇒ transfers

Access the transfers

Returns:

  • transfers



612
613
614
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 612

def transfers
    context.transfers
end

#type ⇒ Type

Returns:



544
545
546
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 544

def type
    @properties['type']
end

#update(status: nil, routing: :unset) ⇒ InteractionChannelInstance

Update the InteractionChannelInstance

Parameters:

  • (defaults to: nil)
  • (defaults to: :unset)

    It changes the state of associated tasks. Routing status is required, When the channel status is set to inactive. Allowed Value for routing status is closed. Otherwise Optional, if not specified, all tasks will be set to wrapping.

Returns:

  • Updated InteractionChannelInstance



591
592
593
594
595
596
597
598
599
600
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 591

def update(
    status: nil, 
    routing: :unset
)

    context.update(
        status: status, 
        routing: routing, 
    )
end

#url ⇒ String

Returns:



568
569
570
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 568

def url
    @properties['url']
end