activities
latest
false
UI Automation Activities
Last updated Oct 28, 2024

Swipe

UiPath.MobileAutomation.Activities.Swipe

Description

This activity targets two elements: Container and Target. Set the Container as the designated area for the swipe operation (typically a list but can be any scrollable element). Specify the Target as the element you're searching for. The swipe operation iterates through multiple swipes on the list (up to MaxNumberOfSwipes) until it locates the specified element. If the Target is not set, the swipe operation performs a single swipe without searching for a specific element.

Configuration

Designer panel
  • Target - Default is set to (null). Once the target is indicated, all properties regarding the element that was indicated are displayed. You can further create variables out of the displayed attributes of an indicated target.
    • CV Text - The text identified by the Computer Vision model in the target UI element.
    • CV Type - The type of control identified using Computer Vision.
      Note: We recommend leaving the CV type of control unaltered after indicating the target. Otherwise, the Computer Vision model might fail to identify the target at runtime, because you changed the control type.
    • Fuzzy selector - The parameters for the fuzzy selector.
    • SearchSteps - Select the methods used to identify targets and anchors from the dropdown list.
    • Strict selector - The selector that is generated for the indicated element.

      To learn how to create variables from the attributes of a target selector, check out the Creating variables from selector attributes tutorial.

  • Container - The target UI container where you want to perform the swipe operation (typically a list, but it can be any scrollable element). Default is set to (null). Once the target container is indicated, all properties regarding the element that was indicated are displayed.
    • CV Text - The text identified by the Computer Vision model in the target UI element.
    • CV Type - The type of control identified using Computer Vision.
      Note: We recommend leaving the CV type of control unaltered after indicating the target. Otherwise, the Computer Vision model might fail to identify the target at runtime, because you changed the control type.
    • Fuzzy selector - The parameters for the fuzzy selector.
    • SearchSteps - Select the methods used to identify targets and anchors from the dropdown list.
    • Strict selector - The selector that is generated for the indicated element.

    • Tap offset (for the target Container) - Set the parameters of your target element. This property is triggered when you enable the Target.
      • Anchoring point - Select the default positioning of the anchor point.
      • CoordinateType - Choose how to set the target coordinates. You can select one of the following:

        • PhysicalPixels - Use this option for workflows using a single device. Since the indication corresponds to actual pixels on the screen, it's different for each device.
        • DeviceIndependentPixels - Use this option to run workflows on devices with similar density screens. Device-independent pixels means that you are indicating a target based on the pixel density of the selected screen area.
      • Offset X - Horizontal displacement of the targeted area selected in the CoordinateType field.
      • Offset Y - Vertical displacement of the targeted area selected in the CoordinateType field.
Properties panel
Common
  • ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
    Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
  • DelayAfter - Delay time (in seconds) after executing the activity. The default value is 0.3 seconds.
  • DelayBefore - Delay time (in seconds) before the activity begins performing any operations. The default value is 0.2 seconds.
  • DisplayName - The display name of the activity.
  • Timeout - specifies the amount of time (in seconds) to wait for a specified element to be found before an error is thrown. The default value is 30 seconds.
Input
  • Target - Default is set to (null). Once the target is indicated, all properties regarding the element that was indicated are displayed. You can further create variables out of the displayed attributes of an indicated target.
    • CV Text - The text identified by the Computer Vision model in the target UI element.
    • CV Type - The type of control identified using Computer Vision.
      Note: We recommend leaving the CV type of control unaltered after indicating the target. Otherwise, the Computer Vision model might fail to identify the target at runtime, because you changed the control type.
    • Fuzzy selector - The parameters for the fuzzy selector.
    • SearchSteps - Select the methods used to identify targets and anchors from the dropdown list.
    • Strict selector - The selector that is generated for the indicated element.

      To learn how to create variables from the attributes of a target selector, check out the Creating variables from selector attributes tutorial.

  • MaxNumberOfSwipes - The maximum number of swipes that are attempted on the specified device. By default, this field is set to 10. This field supports only Int32 variables.
  • SwipeDirection - Specifies the direction in which you want to perform the swipe. The following options are available:
    • Up
    • Down
    • Left
    • Right
  • Tap offset (Optional) - Set the parameters of your target element. This property is triggered when you enable the Target.
    • Anchoring point - Select the default positioning of the anchor point.
    • CoordinateType - Choose how to set the target coordinates. You can select one of the following:

      • PhysicalPixels - Use this option for workflows using a single device. Since the indication corresponds to actual pixels on the screen, it's different for each device.
      • DeviceIndependentPixels - Use this option to run workflows on devices with similar density screens. Device-independent pixels means that you are indicating a target based on the pixel density of the selected screen area.
    • Offset X - Horizontal displacement of the targeted area selected in the CoordinateType field.
    • Offset Y - Vertical displacement of the targeted area selected in the CoordinateType field.
Misc
  • Container - The target UI container where you want to perform the swipe operation (typically a list, but it can be any scrollable element). Default is set to (null). Once the target container is indicated, all properties regarding the element that was indicated are displayed.
    • CV Text - The text identified by the Computer Vision model in the target UI element.
    • CV Type - The type of control identified using Computer Vision.
      Note: We recommend leaving the CV type of control unaltered after indicating the target. Otherwise, the Computer Vision model might fail to identify the target at runtime, because you changed the control type.
    • Fuzzy selector - The parameters for the fuzzy selector.
    • SearchSteps - Select the methods used to identify targets and anchors from the dropdown list.
    • Strict selector - The selector that is generated for the indicated element.

    • Tap offset (for the target Container) - Set the parameters of your target element. This property is triggered when you enable the Target.
      • Anchoring point - Select the default positioning of the anchor point.
      • CoordinateType - Choose how to set the target coordinates. You can select one of the following:

        • PhysicalPixels - Use this option for workflows using a single device. Since the indication corresponds to actual pixels on the screen, it's different for each device.
        • DeviceIndependentPixels - Use this option to run workflows on devices with similar density screens. Device-independent pixels means that you are indicating a target based on the pixel density of the selected screen area.
      • Offset X - Horizontal displacement of the targeted area selected in the CoordinateType field.
      • Offset Y - Vertical displacement of the targeted area selected in the CoordinateType field.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • Description
  • Configuration

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.