Last updated: Apr 06, 2021 17:00
The Perfecto Lab provides support for extended RemoteWebDriver commands, which can be used as an extension to the existing API. For details on the commands, see the Function reference section.
* Click here for a description and code sample of how to execute the Perfecto extensions.
Network
| Command | Description |
| mobile:network.settings:get | Retrieves the network settings specified by the Property parameter, and can insert its value into a defined variable. |
| mobile:network.settings:set | Sets the network settings. |
Services
Command | Description |
Generates an external voice call recording to the selected destination. | |
Sends an email message to the selected destination. | |
Sends an SMS message to the selected destination. |
Visual Analysis
Command | Description |
| mobile:button-image:click | Identifies a button, based on an image, and clicks on it. |
| mobile:button-text:click | Identifies a button, based on a text label, and clicks on it. |
| mobile:edit-image:get | Retrieve the value of an edit field into a variable. |
| mobile:edit-image:set | Set a text value into a form input field. |
| mobile:edit-text:get | Identifies an edit field, based on a text label, and retrieves its value. |
| mobile:edit-text:set | Identifies an edit field, based on a text label, and inserts the specified text in the value parameter into the field. |
| mobile:checkpoint:image | Validate image appearance on the device. |
| mobile:checkpoint:text | Validate appearance of expected text on the device. |
| mobile:image:find | Finds image on the device screen. |
| mobile:image:select | Find an image on the device screen and click on it. |
| mobile:text:find | Finds text (needle) on the device screen (haystack), and stores the coordinates for future commands. |
| mobile:text:select | Finds text (needle) on the device screen (haystack), and clicks it to select the item. |
| mobile:screen:text | Returns the text that appears on the screen of the device without selecting it. |
User Actions
Command | Description |
Perform drag action on a touch screen | |
Performs the selected multi-touch operation, pinch and zoom. | |
Perform a swipe operation on the device. | |
Perform a touch operation on the device. | |
| mobile:trackball:roll | Performs a trackball roll (in BB devices). |
Applications
Command | Description |
Close an application on the device. | |
| mobile:application:back | Moves the application to the background for a specified duration. |
| mobile:application:clean | Brings the application to its initial installation state. |
Install an application from the repository on the device. | |
Start an application on the device. | |
Uninstall all applications from the device. | |
Uninstall an application from the device. | |
| mobile:activity:start | Start an activity (application component) on the device. |
| mobile:activity:sync | Verifies the Android package or activity (application component) has started on the device. |
| mobile:notifications:open | Opens the notifications shade. |
Browser
| Command | Description |
| mobile:browser:clean | Clears the browser content. |
| mobile:browser:execute | Executes a JavaScript script on the device browser application. |
| mobile:browser:open | Opens the browser. |
| mobile:browser:sync | Verifies the browser application is running and page is loaded. |
Device
Command | Description |
Retrieve a log file from the device | |
Set the rotation position of the device | |
Control the virtual keyboard display | |
| mobile:device:info | Retrieves the specified device property value into a defined variable. |
| mobile:handset:ready | Brings the device to its idle / home screen |
| mobile:device:reboot | Reboots the device, and returns it unlocked. |
| mobile:device:recover | Recovers an unresponsive connected device, such as, with an interrupted video, black screen, or touch failure. |
| mobile:screen:lock | Locks the device screen for a specified duration (in seconds). |
| mobile:audio.recording:start | Starts recording the audio output from the device |
| mobile:audio.recording:stop | Completes the recording and saves the audio file to the media storage server |
| mobile:handset:voiceCommand | Sends text String to the device's Voice Assistant (for example, Siri) and allows the assistant to complete the action. |
Events
| Command | Description |
| mobile:audio:inject | Plays an audio file (mp3/wav) into the device audio-in. |
| mobile:key:event | Sends a key event to the device, using key codes and metastates. |
| mobile:presskey | Clicks a single or a sequence of device keyboard keys. |
Files
Command | Description |
Delete the specified file from the device. | |
Copy a file from the device to the repository. | |
Upload a file from the repository to the device. |
Location
| Command | Description |
| mobile:location:get | Gets the device location. |
| mobile:location:reset | Resets the device location. |
| mobile:location:set | Sets the device location. |
Network Virtualization
Command | Description |
Starts network virtualization for the device with the specified conditions. | |
Stops network virtualization for the device and save PCAP file to the repository. | |
Updates network virtualization for the device with the specified conditions. |
Timer
| Command | Description |
| mobile:timer:start | Begins to measure time, with the specified timer ID, until the mobile:timer:stop is invoked. |
| mobile:timer:stop | Stops time measurement of specified timer. |
| mobile:timer:info | Retrieves the specified timer value. |
| mobile:status:timer | Adds a timer report to the test. The measured timer result is reported from the test into the generated Single Test Report. |
Vitals
Command | Description |
Start collecting monitor data | |
Stop collecting monitor data |
Execution Reports
See the Reporting Public API information