Skip to main content

Textbox

Displays a textbox input widget for user text input in chat interfaces.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Session Id - Unique identifier for the UI client connection.
  • Label - Optional label for the textbox.
  • Description - Optional description for the textbox.
  • Placeholder - Optional placeholder text for the textbox.

Options​

  • Input Type - Specifies the input type. Can be either "Text" or "Number".
  • Max Length - Maximum length of the textbox content.
  • Rows - Number of rows to display. You can convert a textbox to a textarea by setting this bigger than 1.

Output​

  • Result - User input from the textbox.

How It Works​

The Textbox node creates an interactive widget that allows users to input text. When executed, the node:

  1. Validates the provided Session ID
  2. Retrieves the session information for the provided ID
  3. Creates a textbox widget with the specified label, description, placeholder, input type, max length, and rows
  4. Sends the widget to the client with the specified session ID
  5. Waits for the user's input
  6. Parses the response as JSON or string
  7. Returns the parsed input as the result

Requirements​

  • A valid session ID for an active client connection
  • Properly configured client interface that can handle textbox widgets

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Failed to send widget to client
  • Timeout while waiting for user input
  • Failed to parse user response

Usage Notes​

  • The Session ID must match an active client connection
  • The Label, Description, and Placeholder fields are optional but can help users understand what they're inputting
  • When Input Type is set to "Number", only numeric input is accepted
  • When Rows is set to 1 (default), a single-line textbox is displayed
  • When Rows is set to a value greater than 1, a multi-line textarea is displayed
  • The Max Length option limits the number of characters a user can input
  • The returned input will be in the format provided by the client (JSON or string)