Class: Twilio::REST::FlexApi::V1::InteractionInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::FlexApi::V1::InteractionInstance
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/interaction.rb
Instance Method Summary collapse
-
#channel ⇒ Hash
A JSON object that defines the Interaction’s communication channel and includes details about the channel.
-
#channels ⇒ channels
Access the channels.
-
#context ⇒ InteractionContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#fetch ⇒ InteractionInstance
Fetch the InteractionInstance.
-
#initialize(version, payload, sid: nil) ⇒ InteractionInstance
constructor
Initialize the InteractionInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #interaction_context_sid ⇒ String
- #links ⇒ Hash
-
#routing ⇒ Hash
A JSON Object representing the routing rules for the Interaction Channel.
-
#sid ⇒ String
The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(webhook_ttid: :unset) ⇒ InteractionInstance
Update the InteractionInstance.
- #url ⇒ String
- #webhook_ttid ⇒ String
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
#channel ⇒ Hash
249 250 251 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 249 def channel @properties['channel'] end |
#channels ⇒ channels
Access the channels
307 308 309 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 307 def channels context.channels end |
#context ⇒ InteractionContext
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 |
#fetch ⇒ InteractionInstance
Fetch the InteractionInstance
286 287 288 289 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 286 def fetch context.fetch end |
#inspect ⇒ Object
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_sid ⇒ String
273 274 275 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 273 def interaction_context_sid @properties['interaction_context_sid'] end |
#links ⇒ Hash
267 268 269 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 267 def links @properties['links'] end |
#routing ⇒ Hash
255 256 257 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 255 def routing @properties['routing'] end |
#sid ⇒ String
243 244 245 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 243 def sid @properties['sid'] end |
#to_s ⇒ Object
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 |
#url ⇒ String
261 262 263 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 261 def url @properties['url'] end |
#webhook_ttid ⇒ String
279 280 281 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction.rb', line 279 def webhook_ttid @properties['webhook_ttid'] end |