Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::WorkerChannelContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, worker_sid, sid) ⇒ WorkerChannelContext

Initialize the WorkerChannelContext

Parameters:

  • version (Version)

    Version that contains the resource

  • workspace_sid (String)

    The SID of the Workspace with the WorkerChannel to fetch.

  • worker_sid (String)

    The SID of the Worker with the WorkerChannel to fetch.

  • sid (String)

    The SID of the WorkerChannel to fetch.


163
164
165
166
167
168
169
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 163

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

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

Instance Method Details

#fetchWorkerChannelInstance

Fetch the WorkerChannelInstance

Returns:


174
175
176
177
178
179
180
181
182
183
184
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 174

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

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

#inspectObject

Provide a detailed, user friendly representation


219
220
221
222
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 219

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

#to_sObject

Provide a user friendly representation


212
213
214
215
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 212

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

#update(capacity: :unset, available: :unset) ⇒ WorkerChannelInstance

Update the WorkerChannelInstance

Parameters:

  • capacity (String) (defaults to: :unset)

    The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.

  • available (Boolean) (defaults to: :unset)

    Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.

Returns:


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

def update(capacity: :unset, available: :unset)
  data = Twilio::Values.of({'Capacity' => capacity, 'Available' => available, })

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

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