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 Task Channel to fetch.

  • sid (String)

    The SID of the Task Channel resource to fetch.


175
176
177
178
179
180
181
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 175

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

#deleteBoolean

Delete the TaskChannelInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


224
225
226
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 224

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

#fetchTaskChannelInstance

Fetch the TaskChannelInstance

Returns:


186
187
188
189
190
191
192
193
194
195
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 186

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

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

#inspectObject

Provide a detailed, user friendly representation


237
238
239
240
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 237

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

#to_sObject

Provide a user friendly representation


230
231
232
233
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 230

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 Task Channel. 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:


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb', line 205

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