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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 271

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



295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 295

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

#error_code ⇒ String 



328
329
330
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 328

def error_code
    @properties['error_code']
end

#error_message ⇒ String 



334
335
336
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 334

def error_message
    @properties['error_message']
end

#fetch ⇒ InteractionChannelInstance

Fetch the InteractionChannelInstance



353
354
355
356
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 353

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



397
398
399
400
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 397

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

#interaction_sid ⇒ String 



310
311
312
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 310

def interaction_sid
    @properties['interaction_sid']
end

#invites ⇒ invites

Access the invites



377
378
379
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 377

def invites
    context.invites
end

#links ⇒ Hash 



346
347
348
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 346

def links
    @properties['links']
end

#participants ⇒ participants

Access the participants



384
385
386
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 384

def participants
    context.participants
end

#sid ⇒ String 



304
305
306
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 304

def sid
    @properties['sid']
end

#status ⇒ ChannelStatus 



322
323
324
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 322

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



390
391
392
393
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 390

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

#type ⇒ Type 



316
317
318
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 316

def type
    @properties['type']
end

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

Update the InteractionChannelInstance



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 363

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

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

#url ⇒ String 



340
341
342
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 340

def url
    @properties['url']
end