Class: Twilio::REST::FlexApi::V1::InteractionInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ InteractionInstance

Initialize the InteractionInstance



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 211

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'channel' => payload['channel'],
        'routing' => payload['routing'],
        'url' => payload['url'],
        'links' => payload['links'],
        'interaction_context_sid' => payload['interaction_context_sid'],
        'webhook_ttid' => payload['webhook_ttid'],
    }

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

Instance Method Details

#channelHash



249
250
251
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 249

def channel
    @properties['channel']
end

#channelschannels

Access the channels



307
308
309
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 307

def channels
    context.channels
end

#contextInteractionContext

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



234
235
236
237
238
239
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 234

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

#fetchInteractionInstance

Fetch the InteractionInstance



286
287
288
289
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 286

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#interaction_context_sidString



273
274
275
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 273

def interaction_context_sid
    @properties['interaction_context_sid']
end


267
268
269
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 267

def links
    @properties['links']
end

#routingHash



255
256
257
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 255

def routing
    @properties['routing']
end

#sidString



243
244
245
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 243

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



313
314
315
316
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 313

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

#update(webhook_ttid: :unset) ⇒ InteractionInstance

Update the InteractionInstance



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

def update(
    webhook_ttid: :unset
)

    context.update(
        webhook_ttid: webhook_ttid, 
    )
end

#urlString



261
262
263
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 261

def url
    @properties['url']
end

#webhook_ttidString



279
280
281
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 279

def webhook_ttid
    @properties['webhook_ttid']
end