CreateTask

typed block

Creates a new task to run an assigned flow.

Factories

`CreateTask`

CreateTask() -> CreateTaskHandle

Construct a fresh CreateTask block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`CreateTask`

CreateTask(id: String) -> CreateTaskHandle

Construct a CreateTask block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`parameters`

parameters(value?: String) -> CreateTaskHandle

Set the Parameters parameter.

Parameter	Type	Required	Description
`value`	`String`	no

`contact_flow_id`

contact_flow_id(value: String) -> CreateTaskHandle

Set the ContactFlowId parameter. A flow ID or flow ARN. Must be fully static or a single valid JSONPath identifier,

Parameter	Type	Required	Description
`value`	`String`	yes	A flow ID or flow ARN. Must be fully static or a single valid JSONPath identifier,

`attributes`

attributes(value?: Map<String, String>) -> CreateTaskHandle

Set the Attributes parameter. { an Object that holds the attributes to be set.

Parameter	Type	Required	Description
`value`	`Map<String, String>`	no	{ an Object that holds the attributes to be set.

`key`

key(value?: String) -> CreateTaskHandle

Set the Key parameter. "Value" Both the key and value may be defined statically or dynamically.

Parameter	Type	Required	Description
`value`	`String`	no	"Value" Both the key and value may be defined statically or dynamically.

`name`

name(value: String) -> CreateTaskHandle

Set the Name parameter. Name of the task that needs to be created. This is a string.,

Parameter	Type	Required	Description
`value`	`String`	yes	Name of the task that needs to be created. This is a string.,

`description`

description(value?: String) -> CreateTaskHandle

Set the Description parameter. Description of the task that needs to be created. This is a string.,

Parameter	Type	Required	Description
`value`	`String`	no	Description of the task that needs to be created. This is a string.,

`references`

references(value?: Map<String, String>) -> CreateTaskHandle

Set the References parameter. { an Object that holds the references to be set.

Parameter	Type	Required	Description
`value`	`Map<String, String>`	no	{ an Object that holds the references to be set.

`type`

type(value?: String) -> CreateTaskHandle

Set the Type parameter. "Value" Both the key and value may be defined statically or dynamically.

Parameter	Type	Required	Description
`value`	`String`	no	"Value" Both the key and value may be defined statically or dynamically.

`delay_seconds`

delay_seconds(value?: String) -> CreateTaskHandle

Set the DelaySeconds parameter. Time in seconds after which the task should be created. This is used to schedule the task by the agent.

Parameter	Type	Required	Description
`value`	`String`	no	Time in seconds after which the task should be created. This is used to schedule the task by the agent.

`scheduled_time`

scheduled_time(value?: String) -> CreateTaskHandle

Set the ScheduledTime parameter. The date and time at which the task should be created. If DelaySeconds is specified, this parameter may not be specified.

Parameter	Type	Required	Description
`value`	`String`	no	The date and time at which the task should be created. If DelaySeconds is specified, this parameter may not be specified.

`task_template_id`

task_template_id(value?: String) -> CreateTaskHandle

Set the TaskTemplateId parameter. ID of the task template that will be used to create the task. This must be defined statically.

Parameter	Type	Required	Description
`value`	`String`	no	ID of the task template that will be used to create the task. This must be defined statically.

`next`

next(target: Handle) -> CreateTaskHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`on_no_matching`

on_no_matching(target: Handle) -> CreateTaskHandle

Wire an error transition for NoMatchingError: if no other Error matches.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches.

`set_id`

set_id(id: String) -> CreateTaskHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> CreateTaskHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> CreateTaskHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> CreateTaskHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> CreateTaskHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> CreateTaskHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> CreateTaskHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> CreateTaskHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).