Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelInstance
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb
Instance Method Summary collapse
-
#context ⇒ InteractionChannelContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#error_code ⇒ String
The Twilio error code for a failed channel.
-
#error_message ⇒ String
The error message for a failed channel.
-
#fetch ⇒ InteractionChannelInstance
Fetch the InteractionChannelInstance.
-
#initialize(version, payload, interaction_sid: nil, sid: nil) ⇒ InteractionChannelInstance
constructor
Initialize the InteractionChannelInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#interaction_sid ⇒ String
The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
-
#invites ⇒ invites
Access the invites.
- #links ⇒ Hash
-
#participants ⇒ participants
Access the participants.
-
#sid ⇒ String
The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.
- #status ⇒ ChannelStatus
-
#to_s ⇒ Object
Provide a user friendly representation.
- #type ⇒ Type
-
#update(status: nil, routing: :unset) ⇒ InteractionChannelInstance
Update the InteractionChannelInstance.
- #url ⇒ String
Constructor Details
#initialize(version, payload, interaction_sid: nil, sid: nil) ⇒ InteractionChannelInstance
Initialize the InteractionChannelInstance
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 268 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
292 293 294 295 296 297 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 292 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.
325 326 327 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 325 def error_code @properties['error_code'] end |
#error_message ⇒ String
Returns The error message for a failed channel.
331 332 333 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 331 def @properties['error_message'] end |
#fetch ⇒ InteractionChannelInstance
Fetch the InteractionChannelInstance
350 351 352 353 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 350 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
394 395 396 397 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 394 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.
307 308 309 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 307 def interaction_sid @properties['interaction_sid'] end |
#invites ⇒ invites
Access the invites
374 375 376 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 374 def invites context.invites end |
#links ⇒ Hash
343 344 345 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 343 def links @properties['links'] end |
#participants ⇒ participants
Access the participants
381 382 383 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 381 def participants context.participants end |
#sid ⇒ String
Returns The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.
301 302 303 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 301 def sid @properties['sid'] end |
#status ⇒ ChannelStatus
319 320 321 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 319 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
387 388 389 390 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 387 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.InteractionChannelInstance #{values}>" end |
#type ⇒ Type
313 314 315 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 313 def type @properties['type'] end |
#update(status: nil, routing: :unset) ⇒ InteractionChannelInstance
Update the InteractionChannelInstance
360 361 362 363 364 365 366 367 368 369 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 360 def update( status: nil, routing: :unset ) context.update( status: status, routing: routing, ) end |
#url ⇒ String
337 338 339 |
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 337 def url @properties['url'] end |