Mobile automation activities and APIs

This section includes testing related activities and APIs found in the UiPath.Mobile.Automation.Activities package. Through these activities and APIs, you can create automations for your devices, running native or web applications.

To create mobile test cases in Studio, you can use the activities available in the Mobile.Automation package. Also, to create mobile coded test cases in Studio, you can use the APIs available in the mobileautomation service, downloaded with the Mobile.Automation package. Visit Mobile Automation APIs to check how to use the Mobile Automation APIs.

Activities

This section includes all activities related to mobile automation found in the Mobile.Automation package.

Activity	Description
Mobile Device Connections	Establishes a connection to a mobile device and provides scope for all subsequent activities/APIs.
Get Log Types	Retrieves the log types from a device connected via the Mobile Device Connection.
Get Logs	Retrieves the logs from a mobile device connected via the Mobile Device Connection scope activity.
Install App	Installs a specified app on a mobile device connected via the Mobile Device Connection.
Get Page Source	Retrieves the page source from a mobile device connected via the Mobile Device Connection scope activity.
Manage Current App	Manages the current app by using a user input command.
Manage Other App	Sends a user input command to a specified app on the target mobile device.
Open Deep Link	Navigates to a deep link inside an application.
Open URL	Opens a specified URL in the currently active web browser.
Get Device Orientation	Retrieves the current orientation of the specified mobile device.
Press Hardware Button	Presses a hardware button on the connected device.
Set Device Orientation	Changes and then retrieves the orientation of the connected device.
Take Screenshot	Takes a screenshot of the screen of the mobile device you are using with custom dimensions specified in the Height and Width properties.
Element Exists	Returns a boolean variable that states whether a specified UI element exists.
Get Attribute	Retrieves an attribute of a specified UI element.
Get Selected Item	Retrieves the selected item from a target UI element.
Get Text	Extracts the text from a specified UI element and returns it as a string variable.
Set Selected Item	Sets the selected item on a target UI element.
Set Text	Types the specified text into a target UI element.
Swipe	Swipes the screen in a specified direction and for a specified amount of times.
Tap	Returns a boolean variable that states whether a specified UI element exists.
Directional Swipe	Perform a swipe operation with the following pre-defined directions: Down, Up, Left, Right.
Draw Pattern	Draws a path marked by multiple points on the device screen.
Type Text	Takes the content typed through the keyboard and pastes it into the currently active UI element.

APIs

This section includes all APIs related to mobile automation found in the Mobile.Automation package.

API	Description
Connect/ConnectAsync	Connects a device to an application.
CreateApplication	Creates a new application and give it a name.
CreateDevice	Creates a new device. You can use this device in code but it will not be saved in Mobile Device Manager.
GetApplication/GetApplications	Gets the application with the specified name (with the same configurations present in Mobile Device Manager).
GetDevice/GetDevices	Gets the device with the specified name (as you configured it in Mobile Device Manager).
DirectionalSwipe	Perform a swipe operation with the following pre-defined directions: Down, Up, Left, Right.
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. For example, you can retrieve the battery info or dismiss alerts (see Appium Commands).
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.
GetSesstionIdentifier	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. If the Target is not set, the swipe operation performs a single swipe without searching for a specific element.
TakeScreenshot	Takes a screenshot of the screen of the mobile device you are using with custom dimensions.
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.