TaskClient

@hideconstructor

Hierarchy

• ResourceClient
  • TaskClient

Index

Constructors

• constructor

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• resourcePath
• safeId
• url

Methods

• call
• delete
• get
• getInput
• lastRun
• runs
• start
• update
• updateInput
• webhooks

Constructors

constructor

• new TaskClient(options: ApiClientSubResourceOptions): TaskClient

• Overrides ResourceClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  Returns TaskClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalid

id?: string

Inherited from ResourceClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

resourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceClient.safeId

url

url: string

Inherited from ResourceClient.url

Methods

call

• call(input?: Dictionary<unknown>, options?: TaskCallOptions): Promise<ActorRun>

• 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-task

  ---

  Parameters

  • optionalinput: Dictionary<unknown>

  • options: TaskCallOptions = {}

  Returns Promise<ActorRun>

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task

  ---

  Returns Promise<void>

get

• get(): Promise<undefined | Task>

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task

  ---

  Returns Promise<undefined | Task>

getInput

• getInput(): Promise<undefined | Dictionary<unknown> | Dictionary<unknown>[]>

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input

  ---

  Returns Promise<undefined | Dictionary<unknown> | Dictionary<unknown>[]>

lastRun

• lastRun(options?: TaskLastRunOptions): RunClient

• https://docs.apify.com/api/v2#/reference/actor-tasks/last-run-object-and-its-storages

  ---

  Parameters

  • options: TaskLastRunOptions = {}

  Returns RunClient

runs

• runs(): RunCollectionClient

• https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection

  ---

  Returns RunCollectionClient

start

• start(input?: Dictionary<unknown>, options?: TaskStartOptions): Promise<ActorRun>

• 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

• update(newFields: Partial<Pick<Task, name | description | title | options | input>>): Promise<Task>

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task

  ---

  Parameters

  • newFields: Partial<Pick<Task, name | description | title | options | input>>

  Returns Promise<Task>

updateInput

• updateInput(newFields: Dictionary<unknown> | Dictionary<unknown>[]): Promise<Dictionary<unknown> | Dictionary<unknown>[]>

• https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input

  ---

  Parameters

  • newFields: Dictionary<unknown> | Dictionary<unknown>[]

  Returns Promise<Dictionary<unknown> | Dictionary<unknown>[]>

webhooks

• webhooks(): WebhookCollectionClient

• https://docs.apify.com/api/v2#/reference/actor-tasks/webhook-collection

  ---

  Returns WebhookCollectionClient