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.



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

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

#fetch ⇒ WorkerChannelInstance

Fetch a WorkerChannelInstance

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 176

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb', line 231

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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