Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskChannelContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ TaskChannelContext

Initialize the TaskChannelContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The SID of the Workspace with the TaskChannel to fetch.

  • sid (String) —

    The SID of the TaskChannel resource to fetch.



182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 182

def initialize(version, workspace_sid, sid)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid, sid: sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskChannels/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the TaskChannelInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



241
242
243
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 241

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ TaskChannelInstance

Fetch a TaskChannelInstance

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 193

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  TaskChannelInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



254
255
256
257
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 254

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

#to_s ⇒ Object

Provide a user friendly representation



247
248
249
250
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 247

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

#update(friendly_name: :unset, channel_optimized_routing: :unset) ⇒ TaskChannelInstance

Update the TaskChannelInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the TaskChannel. It can be up to 64 characters long.

  • channel_optimized_routing (Boolean) (defaults to: :unset) —

    Whether the TaskChannel should prioritize Workers that have been idle. If ‘true`, Workers that have been idle the longest are prioritized.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 218

def update(friendly_name: :unset, channel_optimized_routing: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'ChannelOptimizedRouting' => channel_optimized_routing,
  })

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

  TaskChannelInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end