Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskList

Initialize the TaskList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 20

def initialize(version, workspace_sid: nil)
  super(version)

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

Instance Method Details

#create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset) ⇒ TaskInstance

Retrieve a single page of TaskInstance records from the API. Request is executed immediately.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 233

def create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset)
  data = Twilio::Values.of({
      'Timeout' => timeout,
      'Priority' => priority,
      'TaskChannel' => task_channel,
      'WorkflowSid' => workflow_sid,
      'Attributes' => attributes,
  })

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

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

#each ⇒ Object

When passed a block, yields TaskInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 135

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of TaskInstance records from the API. Request is executed immediately.



203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 203

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  TaskPage.new(@version, response, @solution)
end

#list(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil) ⇒ Array

Lists TaskInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 62

def list(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil)
  self.stream(
      priority: priority,
      assignment_status: assignment_status,
      workflow_sid: workflow_sid,
      workflow_name: workflow_name,
      task_queue_sid: task_queue_sid,
      task_queue_name: task_queue_name,
      evaluate_task_attributes: evaluate_task_attributes,
      ordering: ordering,
      has_addons: has_addons,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of TaskInstance records from the API. Request is executed immediately.



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

def page(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Priority' => priority,
      'AssignmentStatus' => Twilio.serialize_list(assignment_status) { |e| e },
      'WorkflowSid' => workflow_sid,
      'WorkflowName' => workflow_name,
      'TaskQueueSid' => task_queue_sid,
      'TaskQueueName' => task_queue_name,
      'EvaluateTaskAttributes' => evaluate_task_attributes,
      'Ordering' => ordering,
      'HasAddons' => has_addons,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  TaskPage.new(@version, response, @solution)
end

#stream(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams TaskInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 112

def stream(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      priority: priority,
      assignment_status: assignment_status,
      workflow_sid: workflow_sid,
      workflow_name: workflow_name,
      task_queue_sid: task_queue_sid,
      task_queue_name: task_queue_name,
      evaluate_task_attributes: evaluate_task_attributes,
      ordering: ordering,
      has_addons: has_addons,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



253
254
255
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 253

def to_s
  '#<Twilio.Taskrouter.V1.TaskList>'
end