SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface SleepTaskOptions

    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 SleepTaskOptions {
        bed?: MessageInit<BlockPosition>;
        call?: CallOptions;
        causationId?: string;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        retryIntervalTicks?: number;
        searchRadius?: number;
        waitUntilPossible?: boolean;
    }

    Hierarchy (View Summary)

    Index
    bed? call? causationId? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? parentTaskId? path? priority? reconnectPolicy? retryIntervalTicks? searchRadius? waitUntilPossible?
    bed?: MessageInit<BlockPosition>

    Defaults to the nearest loaded bed within searchRadius.

    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;

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

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

    reconnectPolicy?: BotTaskReconnectPolicy

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

    retryIntervalTicks?: number

    Between refused attempts. Defaults to 20, at most 1200.

    searchRadius?: number

    Defaults to 24, at most 32.

    waitUntilPossible?: boolean

    Keeps trying while sleeping isn't possible, such as during the day. Defaults to false for sleep, true for runSleep.

    Settings
    Member Visibility

    On This Page
    Properties