@adcp/client API Reference - v3.3.3
    Preparing search index...

    Class TaskExecutor

    Core task execution engine that handles the conversation loop with agents

    Index

    Constructors

    constructor

    Methods

    executeTask listTasks getTaskStatus pollTaskCompletion resumeDeferredTask getConversationHistory clearConversationHistory getActiveTasks getTaskList getTaskInfo onTaskUpdate onTaskEvents registerWebhook unregisterWebhook

    Constructors

    • Parameters

      • config: {
            workingTimeout?: number;
            pollingInterval?: number;
            defaultMaxClarifications?: number;
            enableConversationStorage?: boolean;
            webhookManager?: WebhookManager;
            deferredStorage?: Storage<DeferredTaskState>;
            webhookUrlTemplate?: string;
            agentId?: string;
            webhookSecret?: string;
            strictSchemaValidation?: boolean;
            logSchemaViolations?: boolean;
            onActivity?: (activity: Activity) => void | Promise<void>;
        } = {}
        • OptionalworkingTimeout?: number

          Default timeout for 'working' status (max 120s per PR #78)

        • OptionalpollingInterval?: number

          Polling interval for 'working' status in milliseconds (default: 2000ms)

        • OptionaldefaultMaxClarifications?: number

          Default max clarification attempts

        • OptionalenableConversationStorage?: boolean

          Enable conversation storage

        • OptionalwebhookManager?: WebhookManager

          Webhook manager for submitted tasks

        • OptionaldeferredStorage?: Storage<DeferredTaskState>

          Storage for deferred task state

        • OptionalwebhookUrlTemplate?: string

          Webhook URL template for protocol-level webhook support

        • OptionalagentId?: string

          Agent ID for webhook URL generation

        • OptionalwebhookSecret?: string

          Webhook secret for HMAC authentication (min 32 chars)

        • OptionalstrictSchemaValidation?: boolean

          Fail tasks when response schema validation fails (default: true)

        • OptionallogSchemaViolations?: boolean

          Log all schema validation violations to debug logs (default: true)

        • OptionalonActivity?: (activity: Activity) => void | Promise<void>

          Global activity callback for observability

      Returns TaskExecutor

    Methods

    • Get task list for a specific agent

      Parameters

      • agentId: string

      Returns Promise<TaskInfo[]>

    • Get detailed information about a specific task

      Parameters

      • taskId: string

      Returns Promise<null | TaskInfo>

    • Subscribe to task updates for a specific agent

      Parameters

      • agentId: string
      • callback: (task: TaskInfo) => void

      Returns () => void

    • Subscribe to task events with detailed callbacks

      Parameters

      • agentId: string
      • callbacks: {
            onTaskCreated?: (task: TaskInfo) => void;
            onTaskUpdated?: (task: TaskInfo) => void;
            onTaskCompleted?: (task: TaskInfo) => void;
            onTaskFailed?: (task: TaskInfo, error: string) => void;
        }

      Returns () => void

    • Register webhook for task notifications

      Parameters

      • agent: AgentConfig
      • webhookUrl: string
      • OptionaltaskTypes: string[]

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods