TaskClient
Hierarchy
- ResourceClient
- TaskClient
Index
Constructors
constructor
Parameters
options: ApiClientSubResourceOptions
Returns TaskClient
Properties
apifyClient
baseUrl
httpClient
optionalid
optionalparams
resourcePath
optionalsafeId
url
Methods
call
Starts a task and waits for it to finish before returning the Run object. It waits indefinitely, unless the
waitSecs
option is provided. https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-taskParameters
optionalinput: Dictionary<unknown>
options: TaskCallOptions = {}
Returns Promise<ActorRun>
delete
Returns Promise<void>
get
Returns Promise<undefined | Task>
getInput
Returns Promise<undefined | Dictionary<unknown> | Dictionary<unknown>[]>
lastRun
Parameters
options: TaskLastRunOptions = {}
Returns RunClient
runs
start
Starts a task and immediately returns the Run object. https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task
Parameters
optionalinput: Dictionary<unknown>
options: TaskStartOptions = {}
Returns Promise<ActorRun>
update
updateInput
Parameters
newFields: Dictionary<unknown> | Dictionary<unknown>[]
Returns Promise<Dictionary<unknown> | Dictionary<unknown>[]>