activities
latest
false
- Overview
- UI Automation
- Applications and technologies automated with UI Automation
- Project compatibility
- UI-ANA-016 - Pull Open Browser URL
- UI-ANA-017 - ContinueOnError True
- UI-ANA-018 - List OCR/Image Activities
- UI-DBP-006 - Container Usage
- UI-DBP-013 - Excel Automation Misuse
- UI-DBP-030 - Forbidden Variables Usage In Selectors
- UI-PRR-001 - Simulate Click
- UI-PRR-002 - Simulate Type
- UI-PRR-003 - Open Application Misuse
- UI-PRR-004 - Hardcoded Delays
- UI-REL-001 - Large Idx in Selectors
- UI-SEC-004 - Selector Email Data
- UI-SEC-010 - App/Url Restrictions
- UI-USG-011 - Non Allowed Attributes
- UX-SEC-010 - App/Url Restrictions
- UX-DBP-029 - Insecure Password Use
- UI-PST-001 - Audit Log Level in Project Settings
- UiPath Browser Migration Tool
- Clipping region
- Computer Vision Recorder
- Activate
- Anchor Base
- Attach Browser
- Attach Window
- Block User Input
- Callout
- Check
- Click
- Click Image
- Click Image Trigger
- Click OCR Text
- Click Text
- Click Trigger
- Close Application
- Close Tab
- Close Window
- Context Aware Anchor
- Copy Selected Text
- Element Attribute Change Trigger
- Element Exists
- Element Scope
- Element State Change Trigger
- Export UI Tree
- Extract Structured Data
- Find Children
- Find Element
- Find Image
- Find Image Matches
- Find OCR Text Position
- Find Relative Element
- Find Text Position
- Get Active Window
- Get Ancestor
- Get Attribute
- Get Event Info
- Get From Clipboard
- Get Full Text
- Get OCR Text
- Get Password
- Get Position
- Get Source Element
- Get Text
- Get Visible Text
- Go Back
- Go Forward
- Go Home
- Google Cloud Vision OCR
- Hide Window
- Highlight
- Hotkey Trigger
- Hover
- Hover Image
- Hover OCR Text
- Hover Text
- Image Exists
- Indicate On Screen
- Inject .NET Code
- Inject Js Script
- Invoke ActiveX Method
- Key Press Trigger
- Load Image
- Maximize Window
- Microsoft Azure Computer Vision OCR
- Microsoft OCR
- Microsoft Project Oxford Online OCR
- Minimize Window
- Monitor Events
- Mouse Trigger
- Move Window
- Navigate To
- OCR Text Exists
- On Element Appear
- On Element Vanish
- On Image Appear
- On Image Vanish
- Open Application
- Open Browser
- Refresh Browser
- Replay User Event
- Restore Window
- Save Image
- Select Item
- Select Multiple Items
- Send Hotkey
- Set Clipping Region
- Set Focus
- Set Text
- Set To Clipboard
- Set Web Attribute
- Show Window
- Start Process
- System Trigger
- Take Screenshot
- Tesseract OCR
- Text Exists
- Tooltip
- Type Into
- Type Secure Text
- Use Foreground
- Wait Attribute
- Wait Element Vanish
- Wait Image Vanish
- Application Event Trigger
- Check/Uncheck
- Check App State
- Check Element
- Click
- Click Event Trigger
- Close Popup
- Drag and Drop
- Extract Table Data
- For Each UI Element
- Get Attribute
- Get Browser Data
- Get Text
- Get URL
- Go to URL
- Highlight
- Hover
- Inject Js Script
- Keyboard Shortcuts
- Keypress Event Trigger
- Mouse Scroll
- Navigate Browser
- Select Item
- Set Browser Data
- Set Runtime Browser
- Set Text
- Take Screenshot
- Type Into
- Use Application/Browser
- Perform browser search and retrieve results using UI Automation APIs
- Web Browsing
- Find Images
- Click Images
- Trigger and Monitor Events
- Create and Override Files
- HTML Pages: Extract and Manipulate Information
- Window Manipulation
- Automated List Selection
- Find and Manipulate Window Elements
- Manage Text Automation
- Load and Process Images
- Manage Mouse Activated Actions
- Automate Application Runtime
- Automated Run of a Local Application
- Browser Navigation
- Web Automation
- Trigger Scope Example
- Computer Vision Local Server
- Mobile Automation
- Release notes
- Project compatibility
- Get Log Types
- Get Logs
- Get Page Source
- Get Device Orientation
- Get Session Identifier
- Install App
- Manage Current App
- Manage Other App
- Open DeepLink
- Open URL
- Mobile Device Connection
- Directional Swipe
- Draw Pattern
- Positional Swipe
- Press Hardware Button
- Set Device Orientation
- Take Screenshot
- Take Screenshot Part
- Element Exists
- Execute Command
- Get Attribute
- Get Selected Item
- Get Text
- Set Selected Item
- Set Text
- Swipe
- Tap
- Type Text
- Terminal
UI Automation Activities
Last updated Oct 28, 2024
APIs
APIs allow you to access and interact with the services offered in the
Manage Packages menu. You can use these APIs when you design coded
automations. Visit Coded Automations to learn about coded automations and how
to design them using APIs.
Note: Using Go to Definition
(
F12) allows you to access the definition of UiPath APIs for a
certain service. We recommend relying only on the directly exposed APIs when you
implement coded automations. Other APIs that are not directly exposed with a service
are subject to change without prior notification.
APIs often have overloads, which means they provide multiple versions of the same method with different parameter options. Overloads allow you to customize the behavior of the API based on your specific requirements. For example, a UI Automation API may have an overload that accepts a timeout parameter to specify the maximum time to wait for a UI element to appear before ending execution.
By using the APIs with their respective overloads, you can easily achieve your desired automation logic and behavior.
This section includes the APIs found in the UiPath.MobileAutomation.API.Models service.
| API | Description |
|---|---|
| Dispose | Releases resources used during automation, clears memory taken up
by these actions, and returns the Connection back
to its original state. This makes these resources available for
other tasks on a Connection.
|
| DrawPattern | Draws a path marked by multiple points on the device screen. The points that create the path are recorded from the path of the finger on the device screen. You can add multiple finger paths to simulate screen interactions that involve multiple fingers. |
| ElementExists | Returns a boolean variable that states whether a specified UI element exists. |
| ExecuteCommand | Execute native mobile commands that are not associated with a specific endpoint. |
| Finalize | Enables an object to perform cleanup operations and release resources before it is reclaimed by garbage collection. Implements the Object.Finalize method. |
| GetAttribute | Retrieves an attribute of a specified UI element. |
| GetDeviceOrientation | Retrieves the current orientation of the specified mobile device. |
| GetLogTypes | Retrieves the log types from a device connected via the mobile
device Connection.
|
| GetPageSource | Retrieves the page source from a mobile device connected via the
Connection class.
|
| GetSelectedItem | Retrieves the selected item from a target UI element. |
| GetSessionIdentifier | Retrieve the session ID of the current Mobile Device Manager connection to route HTTP commands to Appium endpoints so you can perform custom actions. |
| GetSystemTime | Retrieves the current time of the device. |
| GetText | Extracts the text from a specified UI element and returns it as a
String variable.
|
| InstallApp | Installs a specified app on a mobile device connected via
Connection.
|
| ManageCurrentApplication | Resets or launches the current app for this session. |
| ManageOtherApplication | Manages other applications using commands. |
| OpenDeepLink | Opens a deep link inside an application. |
| OpenUrl | Opens a URL in Chrome. The current active application should be Chrome, having at least one opened tab, before calling this method. |
| PositionalSwipe | Swipes to a predefined location on the screen with starting and ending points. |
| PressHardwareButton | Presses a hardware button on the connected device. |
| SaveLogs | Save logs of a specific type to a file. |
| SetDeviceGeoLocation | Sets the current geo-location of the device. |
| SetDeviceOrientation | Changes and then retrieves the orientation of the connected device. |
| SetSelectedItem | Sets the selected item on a target UI element. |
| SetText | Types the specified text into a target UI element, recognized by Mobile Automation. |
| Swipe | The swipe operation iterates through multiple swipes on the list (up to MaxNumberOfSwipes) until it locates the specified element. |
| TakeScreenshot | Takes a screenshot of the screen of the mobile device you are using with custom dimensions specified in the Height and Width parameters. |
| Tap | Returns a boolean variable that states whether a specified UI element exists. The API doesn't have a return value, but if the specified UI element exists (boolean value), then it performs tap operations on it. |
| TypeText | Takes the content typed through the keyboard and pastes it into the currently active UI element. To paste the text inside the element that you want, you need to focus wherever on the UI where you want to paste the text. You can use this API when automating applications for which you need to type text through the keyboard, but without a target element that is recognized by Mobile Automation. |
Use the following format, to call an API from the corresponding service:
service.API. For example, system.GetAsset.
To use Mobile Automation APIs, you first establish a connection to your device and
application (visit Connection to learn more), then call the desired automation methods on this
connection, such as
connection.Tap(<selector>); or var
orientation = connection.GetDeviceOrientation();.
