WorkflowScriptContextParams extension

Typed read helpers for workflow start parameters in script run methods.

on

• WorkflowScriptContext

Methods

param<T>(String key, {PayloadCodec<T>? codec}) → T?

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter for key, or null.

paramJson<T>(String key, {required T decode(Map<String, dynamic> payload), String? typeName}) → T?

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO for key, or null.

paramJsonOr<T>(String key, T fallback, {required T decode(Map<String, dynamic> payload), String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO for key, or fallback.

paramListJson<T>(String key, {required T decode(Map<String, dynamic> payload), String? typeName}) → List<T>?

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO list for key, or null.

paramListJsonOr<T>(String key, List<T> fallback, {required T decode(Map<String, dynamic> payload), String? typeName}) → List<T>

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO list for key, or fallback.

paramListVersionedJson<T>(String key, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → List<T>?

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO list for key, or null.

paramListVersionedJsonOr<T>(String key, List<T> fallback, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → List<T>

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO list for key, or fallback.

paramOr<T>(String key, T fallback, {PayloadCodec<T>? codec}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter for key, or fallback.

paramsAs<T>({required PayloadCodec<T> codec}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Decodes the full workflow start-parameter payload through codec.

paramsJson<T>({required T decode(Map<String, dynamic> payload), String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Decodes the full workflow start-parameter payload as a DTO.

paramsVersionedJson<T>({required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Decodes the full workflow start-parameter payload as a version-aware DTO.

paramVersionedJson<T>(String key, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → T?

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO for key, or null.

paramVersionedJsonOr<T>(String key, T fallback, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO for key, or fallback.

requiredParam<T>(String key, {PayloadCodec<T>? codec}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter for key, throwing when absent.

requiredParamJson<T>(String key, {required T decode(Map<String, dynamic> payload), String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO for key, throwing when absent.

requiredParamListJson<T>(String key, {required T decode(Map<String, dynamic> payload), String? typeName}) → List<T>

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded workflow parameter DTO list for key, throwing when absent.

requiredParamListVersionedJson<T>(String key, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → List<T>

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO list for key, throwing when absent.

requiredParamVersionedJson<T>(String key, {required T decode(Map<String, dynamic> payload, int version), int defaultVersion = 1, int? defaultDecodeVersion, String? typeName}) → T

Available on WorkflowScriptContext, provided by the WorkflowScriptContextParams extension

Returns the decoded version-aware workflow parameter DTO for key, throwing when absent.