ToolName enum

AI tool-call names used by the assistant agent.

Replaces string magic across AI/agent code. Use ToolName.name to obtain the canonical wire string (matches the existing string identifiers exactly, e.g. ToolName.tapElement.wireName == 'tap_element').

Backed by snake_case wire identifiers via wireName; Dart enum members use the project's lowerCamelCase convention.

Inheritance

Object
Enum
ToolName

Available extensions

EnumName

Values

askUser → const ToolName: Ask the end-user a clarification question.

const ToolName('ask_user')
decreaseValue → const ToolName: Decrease a numeric field's value.

const ToolName('decrease_value')
getScreenContent → const ToolName: Capture the current screen as structured content for the model.

const ToolName('get_screen_content')
goBack → const ToolName: Navigate back in the router stack.

const ToolName('go_back')
handOffToUser → const ToolName: Hand control of the conversation back to the user.

const ToolName('hand_off_to_user')
increaseValue → const ToolName: Increase a numeric field's value.

const ToolName('increase_value')
longPressElement → const ToolName: Long-press a UI element.

const ToolName('long_press_element')
navigateToRoute → const ToolName: Navigate to a named route.

const ToolName('navigate_to_route')
scroll → const ToolName: Scroll a scrollable region.

const ToolName('scroll')
setText → const ToolName: Set text in a text field.

const ToolName('set_text')
tapElement → const ToolName: Tap a UI element.

const ToolName('tap_element')

Properties

hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
name → String: Available on Enum, provided by the EnumName extension
The name of the enum value.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
wireName → String: Canonical wire identifier (snake_case) used by LLM providers and logs.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

fromString(String name) → ToolName: Resolve a wire identifier (e.g. 'tap_element') to its ToolName.
tryFromString(String name) → ToolName?: Same as fromString but returns null instead of throwing.

Constants

values → const List<ToolName>: A constant List of the values in this enum, in order of their declaration.