GDSL commands for iOS
update 25 nov 2024
Command catalog
Here is the description of the DSL commands grouped by domain.
Application
Browser Manager
Click
Device
Find
Probe
Scroll
Set text
Wait objects
Â
A parameter for a command should not contain any comma as it is the separator character.
Application
Command | Example | Description |
---|---|---|
applicationStart |
| Starts an application from its package name. compatibility : universal |
applicationKill |
| Forces an application to stop from its package name. compatibility : universal |
installApp |
| Installs the application from its package name. |
Browser Manager
Command | Example | Description |
---|---|---|
launchBrowser | Â | Launches the current set browser. If not set, launches default browser Chrome. |
browserGoToUrl |
| Browses the given url on the current set browser. |
browserClearCache | Â | Clears the cache of Safari. |
browserPrepareAndOpen | Â | Prepares browser for measurement. Clear cache, close all tabs, close browser and reopen it. |
browserPrepareAndOpenForReference | Â | Prepares browser for measurement. Clear cache, close all tabs, close browser and reopen it, go to a black page and wait 60s. |
Click
Command | Example | Description |
---|---|---|
longClickByText |
| Performs a long click for the given duration on the element which contains the given text selector. default : 1000 optional duration compatibility : universal |
longClickByXY |
| Performs a long click of the given duration on the given coordinate. default : 1000 compatibility : universal |
clickByText |
| Clicks on the element which contains the given text selector. CASE-SENSITIVE compatibility : universal |
clickByTextExact |
| Clicks on the element which contains the exact given text selector. CASE-SENSITIVE compatibility : universal |
clickByXY |
| Clicks on the element located at the given coordinates. compatibility : universal |
clickByPercent |
| Clicks on the element located at the coordinates calculated from the given percentages of the device screen. compatibility : universal |
clickByTextOnSystemPopup |
| Clicks on a system popup that is not detected automatically which contains the given text selector. System popups that are detected automatically are accepted by default. |
clickOnLastElementFound | Â | Clicks on the last element found by previous GDSL command in group Find like compatibility : universal |
Device
Command | Example | Description |
---|---|---|
pause |
| Waits the amount of time in millisecond passed as argument. compatibility : universal |
pressHome |
| Presses the home button. compatibility : universal |
pressVolumeDown |
| Presses the volume down button. compatibility : universal |
pressVolumeUp |
| Presses the volume up button. compatibility : universal |
Find
Command | Example | Description |
---|---|---|
findByText |
| Finds the nth element which text or content-desc contains the given selector. The element is saved as the last element found. CASE-SENSITIVE default rank : 1 optional rank compatibility : universal |
findByTextExact |
| Finds the nth element which text or content-desc is the exact given selector. The element is saved as the last element found. CASE-SENSITIVE default rank : 1 optional rank compatibility : universal |
findByClass |
| Finds the nth element with the class selector. The element is saved as the last element found. default rank : 1 optional rank compatibility : universal |
Probe
Command | Example | Description |
---|---|---|
measureStart |
| Starts a measure which can be identified by the given name. compatibility : universal |
measureStop | Â | Stops the current measure. compatibility : universal |
Scroll
Command | Example | Description |
---|---|---|
scrollDownward | Â | Scrolls downward the screen (only one scroll). compatibility : universal |
scrollUpward | Â | Scrolls upward the screen (only one scroll). compatibility : universal |
scrollLeftward | Â | Scrolls leftward the screen (only one scroll). compatibility : universal |
scrollRightward | Â | Scrolls rightward the screen (only one scroll). compatibility : universal |
swipeRightward |
| Swipes rightward the screen. The swipe gesture is from screen point A (X 90%, Y percY) to screen point B (X 10%, Y percY). compatibility : universal |
swipeLeftward |
| Swipes leftward the screen. The swipe gesture is from screen point A (X 10%, Y percY) to screen point B (X 90%, Y percY). compatibility : universal |
swipeUpward |
| Swipes upward the screen. The swipe gesture is from screen point A (X percX, Y percStartY) to screen point B (X percX, Y 90%). default percx : 50 default percstarty : 10 optional perc compatibility : universal |
swipeDownward |
| Swipes downward the screen. The swipe gesture is from screen point A (X percX, Y percStartY) to screen point B (X percX, Y 10%). default percx : 50 default percstarty : 90 optional perc compatibility : universal |
swipeVertical |
| Swipes vertically the screen. The swipe gesture is from screen point A (X percX, Y percStartY) to screen point B (X percX, Y percEndY). default duration : 500 optional duration compatibility : universal |
swipeHorizontal |
| Swipes horizontally the screen. The swipe gesture is from screen point A (X percStartX, Y percY) to screen point B (X percEndX, Y percY). default duration : 500 optional duration compatibility : universal |
swipeDownwardToText |
| Swipes downward to find the first element which contains the given selector. The swipe gesture is from screen point A (X 50%, Y 90%) to screen point B (X 50%, Y 10%). case-insensitive default iterations : 10 (max 30) compatibility : universal |
swipeUpwardToText |
| Swipes upward to find the first element which contains the given selector. The swipe gesture is from screen point A (X 50%, Y 10%) to screen point B (X 50%, Y 90%). CASE-SENSITIVE default iterations : 10 (max 30) default percx: 50 optional iterations and percx compatibility : universal |
Set Text
Command | Example | Description |
---|---|---|
setTextByText |
| Pastes the given text into the element which contains the given text selector. compatibility : universal |
setTextByTextExact |
| Pastes the given text into the element which has the given exact text selector. compatibility : universal |
enterText |
| Enters the given text in the current selected field clicking on the keyboard keys for each character. Text is entered character by character at the given frequency optional frequency compatibility : universal |
enterTextFast |
| Taps the text specified in parameter. Enter all text at once. compatibility : universal |
Wait Object
Command | Example | Description |
---|---|---|
waitUntilText |
| Waits for a view element with text specified, to become visible on the screen until a specified timeout. If it is not found, an error is thrown. CASE-inSENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilAccessibilityField |
| Waits for a view element with name (Appium Inspector) or identifier (dump) specified, to become visible on the screen until a specified timeout. If it is not found, an error is thrown. CASE-inSENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilTextBeforeClick |
| Waits for a view element with text specified, to become visible on the screen and then clicks on it. If false, it waits 10 second max before the error thrown. If true, it waits 2 seconds max. default boolean : false optional boolean compatibility : universal |
waitUntilAccessibilityFieldBeforeClick |
| Waits for a view element with name (Appium Inspector) or identifier (dump) specified, to become visible on the screen and then clicks on it. If false, it waits 10 second max before the error thrown. If true, it waits 2 seconds max. default boolean : false optional boolean CASE-inSENSITIVE compatibility : universal |
waitUntilTextExact |
| Waits for a view element, with the exact text selected, to become visible on the screen until a specified timeout. If it is not found, an error is thrown. CASE-SENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilTextExactBeforeClick |
| Waits for a view element, with the exact text selected, to become visible on the screen and then clicks on it. If false, it waits 10 second max before the error thrown. If true, it waits 2 seconds max. CASE-SENSITIVE default boolean : false optional boolean compatibility : universal |
waitUntilAccessibilityFieldExact |
| Waits for a view element, with the exact name (Appium Inspector) or identifier (dump) selected, to become visible on the screen until a specified timeout. If it is not found, an error is thrown. CASE-SENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilAccessibilityFieldExactBeforeClick |
| Waits for a view element, with the exact name (Appium Inspector) or identifier (dump) selected, to become visible on the screen and then clicks on it. If false, it waits 10 second max before the error thrown. If true, it waits 2 seconds max. CASE-SENSITIVE default boolean : false optional boolean compatibility : universal |
waitUntilGoneText |
| Waits until there is no view element, with text selected, visible on the screen until a specified timeout. If it is still found, an error is thrown. CASE-inSENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilGoneTextExact |
| Waits until there is no view element, with the exact text selected, visible on the screen until a specified timeout. If it is still found, an error is thrown. CASE-SENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilGoneAccessibilityField |
| Waits until there is no view element, with name (Appium Inspector) or identifier (dump) selected, visible on the screen until a specified timeout. If it is still found, an error is thrown. CASE-inSENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilGoneAccessibilityFieldExact |
| Waits until there is no view element, with name (Appium Inspector) or identifier (dump) selected, visible on the screen until a specified timeout. If it is still found, an error is thrown. CASE-SENSITIVE default timeout: 30000 optional timeout compatibility : universal |
waitUntilTextOnSystemPopup |
| Wait for a system popup that is not detected automatically which contains the given text selector. System popups that are detected automatically are accepted by default. CASE-inSENSITIVE default timeout: 30000 optional timeout compatibility : universal |
Â