SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface FishTaskOptions

    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 FishTaskOptions {
        biteTimeoutTicks?: number;
        call?: CallOptions;
        castTimeoutTicks?: number;
        causationId?: string;
        completeWhenNoRod?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        maximumCatches?: number;
        maximumFailedCasts?: number;
        parentTaskId?: string;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        restoreSelectedSlot?: boolean;
        rod?: MessageInit<ItemSelector>;
    }

    Hierarchy (View Summary)

    Index
    biteTimeoutTicks? call? castTimeoutTicks? causationId? completeWhenNoRod? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? maximumCatches? maximumFailedCasts? parentTaskId? priority? reconnectPolicy? restoreSelectedSlot? rod?
    biteTimeoutTicks?: number

    Defaults to 12000, at most 72000.

    call?: CallOptions
    castTimeoutTicks?: number

    Defaults to 100, at most 1200.

    causationId?: string

    from field: optional string causation_id = 10;

    completeWhenNoRod?: boolean

    Defaults to true for fish, false for runFish.

    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;

    maximumCatches?: number

    0 fishes until cancelled. Defaults to 1 for fish, 0 for runFish.

    maximumFailedCasts?: number

    0 (the default) means no limit.

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    priority?: BotTaskPriority

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

    reconnectPolicy?: BotTaskReconnectPolicy

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

    restoreSelectedSlot?: boolean

    Defaults to true.

    rod?: MessageInit<ItemSelector>

    Limits which fishing rod may be picked.

    Settings
    Member Visibility

    On This Page
    Properties