SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface BuildTaskOptions

    Scheduling, ownership, and request options for a durable bot task.

    Unspecified policies use server defaults. RPC timeouts and task deadlines control different stages. Reuse an idempotency key when retrying a submission.

    interface BuildTaskOptions {
        breakIncorrectBlocks?: boolean;
        call?: CallOptions;
        causationId?: string;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        mirror?: BuildMirror;
        parentTaskId?: string;
        partitionCount?: number;
        partitionIndex?: number;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        restoreSelectedSlot?: boolean;
        rotation?: BuildRotation;
        substitutions?: Readonly<Record<string, readonly string[]>>;
    }

    Hierarchy (View Summary)

    Index
    breakIncorrectBlocks? call? causationId? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? mirror? parentTaskId? partitionCount? partitionIndex? path? priority? reconnectPolicy? restoreSelectedSlot? rotation? substitutions?
    breakIncorrectBlocks?: boolean

    Defaults to true.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    conflictPolicy?: BotTaskConflictPolicy

    from field: soulfire.v1.BotTaskConflictPolicy conflict_policy = 4;

    deadline?: Date

    The task ends as TIMED_OUT at this time. Must be in the future.

    disconnectPolicy?: BotTaskDisconnectPolicy

    from field: soulfire.v1.BotTaskDisconnectPolicy disconnect_policy = 6;

    idempotencyKey?: string

    from field: optional string idempotency_key = 11;

    mirror?: BuildMirror

    Defaults to NONE.

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    partitionCount?: number
    partitionIndex?: number

    Splits the blocks between bots: this one builds part partitionIndex of partitionCount. partitionIndex defaults to 0 and partitionCount to 1.

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

    from field: soulfire.v1.BotTaskPriority priority = 7;

    reconnectPolicy?: BotTaskReconnectPolicy

    from field: soulfire.v1.BotTaskReconnectPolicy reconnect_policy = 5;

    restoreSelectedSlot?: boolean

    Defaults to true.

    rotation?: BuildRotation

    Defaults to NONE.

    substitutions?: Readonly<Record<string, readonly string[]>>

    Block ids that may be placed instead of a block id of the schematic.

    Settings
    Member Visibility

    On This Page
    Properties