Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Command catalog

Here is the description of the DSL commands grouped by domain.

A parameter for a command should not contain any comma as it is the separator character.

Application

Command

Example

Description

applicationStart

applicationStart,[PACKAGE]

Starts an application from its package name.

COMPATIBILITY : UNIVERSAL

applicationKill

applicationKill,[PACKAGE]

Forces an application to stop from its package name.

COMPATIBILITY : UNIVERSAL

installApp

installApp,[PACKAGE]

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

browserGoToUrl,https://greenspector.com/

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

longClickByText,[TEXT]

longClickByText,[TEXT],[DURATION]

Performs a long click for the given duration on the element which contains the given text selector.

DEFAULT : 1000 OPTIONAL DURATION COMPATIBILITY : UNIVERSAL

longClickByXY

longClickByXY,[X-POS],[Y-POS]

Performs a long click of the given duration on the given coordinate.

DEFAULT : 1000 COMPATIBILITY : UNIVERSAL

clickByText

clickByText,[TEXT]

Clicks on the element which contains the given text selector.

CASE-SENSITIVE COMPATIBILITY : UNIVERSAL

clickByTextExact

clickByTextExact,[TEXT]

Clicks on the element which contains the exact given text selector.

CASE-SENSITIVE COMPATIBILITY : UNIVERSAL

clickByXY

clickByXY,[X-Pos],[Y-Pos]

Clicks on the element located at the given coordinates.

COMPATIBILITY : UNIVERSAL

clickByPercent

clickByPercent,[X-Perc],[Y-Perc]

Clicks on the element located at the coordinates calculated from the given percentages of the device screen.

COMPATIBILITY : UNIVERSAL

clickByTextOnSystemPopup

clickByTextOnSystemPopup,[TEXT]

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 findByText or findByTextExact.

COMPATIBILITY : UNIVERSAL

Device

Command

Example

Description

pause

pause,[DURATION]

Waits the amount of time in millisecond passed as argument.

COMPATIBILITY : UNIVERSAL

pressHome

pressHome

Presses the home button.

COMPATIBILITY : UNIVERSAL

pressVolumeDown

pressVolumeDown

Presses the volume down button.

COMPATIBILITY : UNIVERSAL

pressVolumeUp

pressVolumeUp

Presses the volume up button.

COMPATIBILITY : UNIVERSAL

Find

Command

Example

Description

findByText

findByText,[TEXT]

findByText,[TEXT],[RANK]

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

findByText,[EXACT-TEXT]

findByText,[EXACT-TEXT],[RANK]

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

findById,[CLASS]

findById,[CLASS],[RANK]

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

measureStart,CHRGT_home

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

swipeRighward,[percY]

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

swipeLeftward,[percY]

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

swipeUpward

swipeUpward,[percX],[percStartY]

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

swipeDownward

swipeDownward,[percX],[percStartY]

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

swipeVertical,[percStartY],[percEndY],[percX]

swipeVertical,[percStartY],[percEndY],[percX],[DURATION]

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

swipeHorizontal,[percStartX],[percEndX],[percY]

swipeHorizontal,[percStartX],[percEndX],[percY],[DURATION]

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

swipeDownwardToText,[TEXT]

swipeDownwardToText,[TEXT],[ITERATION],[percX]

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

swipeUpwardToText,[TEXT]

swipeUpwardToText,[TEXT],[ITERATIONS],[percX]

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

setTextByText,[TEXT],[TEXT-SELECTOR]

Pastes the given text into the element which contains the given text selector.

COMPATIBILITY : UNIVERSAL

setTextByTextExact

setTextByText,[TEXT],[EXACT-TEXT-SELECTOR]

Pastes the given text into the element which has the given exact text selector.

COMPATIBILITY : UNIVERSAL

enterText

enterText,[TEXT]

enterText,[TEXT],[FREQUENCY]

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

enterTextFast,[TEXT]

Taps the text specified in parameter. Enter all text at once.

COMPATIBILITY : UNIVERSAL

Wait Object

Command

Example

Description

waitUntilText

waitUntilText,[TEXT]

waitUntilText,[TEXT],[TIMEOUT]

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

waitUntilDesc,[NAME/ID]

waitUntilDesc,[NAME/ID],[TIMEOUT]

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

  • waitUntilTextBeforeClick,[TEXT] = waitUntilTextBeforeClick,[TEXT],false

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

  • waitUntilDescBeforeClick,[NAME/ID] = waitUntilDescBeforeClick,[NAME/ID],false

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

waitUntilTextExact,[EXACT-TEXT]

waitUntilTextExact,[EXACT-TEXT],[TIMEOUT]

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

  • waitUntilTextExactBeforeClick,[EXACT-TEXT] = waitUntilTextExactBeforeClick,[EXACT-TEXT],false

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

waitUntilDescExact,[EXACT-NAME/ID]

waitUntilDescExact,[EXACT-NAME/ID],[TIMEOUT]

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

  • waitUntilDescExactBeforeClick,[EXACT-NAME/ID] = waitUntilDescExactBeforeClick,[EXACT-NAME/ID],false

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

waitUntilGoneText,[TEXT]

waitUntilGoneText,[TEXT],[TIMEOUT]

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

waitUntilGoneTextExact,[EXACT-TEXT]

waitUntilGoneTextExact,[EXACT-TEXT],[TIMEOUT]

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

waitUntilGoneDesc,[NAME/ID]

waitUntilGoneDesc,[NAME/ID],[TIMEOUT]

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

waitUntilGoneDescExact,[EXACT-NAME/ID]

waitUntilGoneDescExact,[EXACT-NAME/ID],[TIMEOUT]

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

waitUntilTextOnSystemPopup,[TEXT]

waitUntilTextOnSystemPopup,[TEXT],[TIMEOUT]

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

  • No labels