Ask AI
Skip to main content

Get vertical list ui element by code

Function: Get vertical list UI element by code​

This action helps you locate a specific "vertical list" user interface (UI) element within your application's current screen or template. You can find the element by providing its unique identifier, often referred to as its "code." Once found, this action makes the UI element available for use in subsequent steps of your workflow.

Input​

  • Code: (Text)
    • The unique identifier (code) of the vertical list UI element you want to find. This is a required input.

Output​

  • Vertical list UI element: (Type: UI Element, Subtype: Vertical List)
    • Description: This is the vertical list UI element that the action successfully finds using its unique code.
    • Variable Name: The found UI element will be stored in a variable. By default, this variable is named VERTICAL_LIST_COMPONENT, but you can choose a different name when configuring the action.

Execution Flow​

Real-Life Examples​

Here are some examples of how you might use the "Get vertical list UI element by code" action:

Example 1: Displaying a list of products

  • Scenario: You have a product catalog page with a vertical list UI element that displays all available products. You want to retrieve this list to perform an action on it, like refreshing its content.
  • Inputs:
    • Code: PRODUCT_LIST_SECTION
    • Output Variable Name: myProductList
  • Result: The action finds the vertical list UI element with the code PRODUCT_LIST_SECTION and stores it in a variable named myProductList. You can then use myProductList in a subsequent action to, for example, Refresh UI Element.

Example 2: Checking user notifications

  • Scenario: Your application has a notification center on the dashboard, implemented as a vertical list. You need to get this list to check if there are any unread notifications.
  • Inputs:
    • Code: USER_NOTIFICATIONS
    • Output Variable Name: (Uses default) VERTICAL_LIST_COMPONENT
  • Result: The action successfully locates the vertical list UI element with the code USER_NOTIFICATIONS. This element is stored in the default variable VERTICAL_LIST_COMPONENT, which you can then use to count items or filter for unread messages.

Example 3: Handling a missing component

  • Scenario: You are trying to find a specific vertical list component, but you've entered an incorrect code, or the component has been removed from the template.
  • Inputs:
    • Code: NON_EXISTENT_LIST
    • Output Variable Name: foundList
  • Result: The action attempts to find the vertical list UI element. Since no component with the code NON_EXISTENT_LIST exists, the action will fail and generate an error message indicating that the vertical list component could not be found. This prevents your workflow from proceeding with an invalid UI element.