Skip to content

tasks.md

Latest commit

 

History

History
62 lines (49 loc) · 2.86 KB

tasks.md

File metadata and controls

62 lines (49 loc) · 2.86 KB
Raw

Tasks

Tasks are pre-configured Actor runs with stored input. Access the collection with client.Tasks() and a specific task with client.Task(id).

Collection

  • ListAsync(ListOptions? options = null) → PaginationList<ActorTask>; IterateAsync(ListOptions? options = null) → IAsyncEnumerable<ActorTask> (lazy, all pages).
  • CreateAsync(object task) → ActorTask.

Single task — client.Task(id)

  • GetAsync() → ActorTask?; UpdateAsync(object newFields) → ActorTask; DeleteAsync().
  • PublishAsync() → ActorTask — publishes the task on its public landing page in Apify Store (sets isPublic: true). The task's Actor must be public and the task must already have PublicConfig set up. Requires write permission to both the task and its Actor. Publishing an already published task does nothing.
  • UnpublishAsync() → ActorTask — unpublishes the task (sets isPublic: false); PublicConfig is preserved so the task can be published again without re-entering it. Requires write permission to both the task and its Actor. Unpublishing a task that is not published does nothing.
  • StartAsync(object? input = null, TaskStartOptions? options = null) → ActorRun.
  • CallAsync(object? input = null, TaskStartOptions? options = null, int? waitSecs = null, Action<string>? log = null) → ActorRun (log, if set, redirects the run's live log to that sink for the duration of the wait).
  • GetInputAsync() → JsonNode? / UpdateInputAsync(object input) → JsonNode?.
  • LastRun(LastRunOptions? options = null) → RunClient; Runs() → RunCollectionClient.
  • Webhooks() → read-only NestedWebhookCollectionClient.

TaskStartOptions overrides the task's stored run settings for a single start: Build, MemoryMbytes, TimeoutSecs, WaitForFinish (server-side wait on the start call, max 60), MaxItems, MaxTotalChargeUsd, RestartOnError, and Webhooks (ad-hoc webhooks for this run). See Actors for the meaning of each field.

The model is named ActorTask (not Task) to avoid colliding with System.Threading.Tasks.Task.

using System;
using Apify.Client;

var client = new ApifyClient("my-api-token");
var task = await client.Tasks().CreateAsync(new
{
    actId = "apify/hello-world",
    name = "my-task",
    input = new { message = "hello" },
});

await client.Task(task.Id!).UpdateInputAsync(new { message = "updated" });
var run = await client.Task(task.Id!).CallAsync(null, null, 120);
Console.WriteLine(run.Status);

Publishing a task requires its Actor to be public and the task to have PublicConfig set up first:

var taskClient = client.Task(task.Id!);
await taskClient.UpdateAsync(new { publicConfig = new { seoTitle = "My task" } });
var published = await taskClient.PublishAsync();
Console.WriteLine(published.IsPublic == true);

await taskClient.UnpublishAsync();