Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelContext::InteractionChannelParticipantContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, interaction_sid, channel_sid, sid) ⇒ InteractionChannelParticipantContext

Initialize the InteractionChannelParticipantContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • interaction_sid (String) —

    The Interaction Sid for this channel.

  • channel_sid (String) —

    The Channel Sid for this Participant.

  • sid (String) —

    The unique string created by Twilio to identify an Interaction Channel resource.



183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 183

def initialize(version, interaction_sid, channel_sid, sid)
  super(version)

  # Path Solution
  @solution = {interaction_sid: interaction_sid, channel_sid: channel_sid, sid: sid, }
  @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:channel_sid]}/Participants/#{@solution[:sid]}"
end

Instance Method Details

#inspect ⇒ Object

Provide a detailed, user friendly representation



219
220
221
222
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 219

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.FlexApi.V1.InteractionChannelParticipantContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



212
213
214
215
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 212

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.FlexApi.V1.InteractionChannelParticipantContext #{context}>"
end

#update(status: nil) ⇒ InteractionChannelParticipantInstance

Update the InteractionChannelParticipantInstance

Parameters:

  • status (interaction_channel_participant.Status) (defaults to: nil) —

    The Participant’s status. Can be: ‘closed` or `wrapup`. Participant must be an agent.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb', line 196

def update(status: nil)
  data = Twilio::Values.of({'Status' => status, })

  payload = @version.update('POST', @uri, data: data)

  InteractionChannelParticipantInstance.new(
      @version,
      payload,
      interaction_sid: @solution[:interaction_sid],
      channel_sid: @solution[:channel_sid],
      sid: @solution[:sid],
  )
end