TaskInputContext class abstract interface

Shared input surface for task execution contexts that retain invocation args.

Implementers

• TaskExecutionContext

Available extensions

• TaskInputContextArgs

Properties

args → Map<String, Object?>

Arguments supplied to the current task invocation.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

arg<T>(String key, {Codec<T, Object?>? codec}) → T?

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg for key, or null.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO for key, or null.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO for key, or fallback.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO list for key, or null.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO list for key, or fallback.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO list for key, or null.

argListVersionedJsonOr<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 TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO list for key, or fallback.

argOr<T>(String key, T fallback, {Codec<T, Object?>? codec}) → T

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg for key, or fallback.

argsAs<T>({required Codec<T, Object?> codec}) → T

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Decodes the full task-argument payload through codec.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Decodes the full task-argument payload as a DTO.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Decodes the full task-argument payload as a version-aware DTO.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO for key, or null.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO for key, or fallback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

requiredArg<T>(String key, {Codec<T, Object?>? codec}) → T

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg for key, throwing when absent.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO for key, throwing when absent.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded task arg DTO list for key, throwing when absent.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO list for key, throwing when absent.

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

Available on TaskInputContext, provided by the TaskInputContextArgs extension

Returns the decoded version-aware task arg DTO for key, throwing when absent.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited