Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titleupdate 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.

Excerpt
nameapplication

Application

Command

Example

Description

applicationStart

applicationStart,[PACKAGE]

Starts an application from its package name.

Status
colourYellow
titlecompatibility : universal

applicationKill

applicationKill,[PACKAGE]

Forces an application to stop from its package name.

Status
colourYellow
titlecompatibility : universal

installApp

installApp,[PACKAGE]

Installs the application from its package name.

Excerpt
namebrowsermanager

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.

Excerpt
nameclick

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.

Status
titledefault : 1000
Status
colourBlue
titleoptional duration
Status
colourYellow
titlecompatibility : universal

longClickByXY

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

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

Status
titledefault : 1000
Status
colourYellow
titlecompatibility : universal

clickByText

clickByText,[TEXT]

Clicks on the element which contains the given text selector.

Status
colourPurple
titleCASE-SENSITIVE
Status
colourYellow
titlecompatibility : universal

clickByTextExact

clickByTextExact,[TEXT]

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

Status
colourPurple
titleCASE-SENSITIVE
Status
colourYellow
titlecompatibility : universal

clickByXY

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

Clicks on the element located at the given coordinates.

Status
colourYellow
titlecompatibility : universal

clickByPercent

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

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

Status
colourYellow
titlecompatibility : 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.

...

namedevice

clickOnLastElementFound

Clicks on the last element found by previous GDSL command in group Find like findByText or findByTextExact.

Status
colourYellow
titlecompatibility : universal

Excerpt
namedevice

Device

Command

Example

Description

pause

pause,[DURATION]

Waits the amount of time in millisecond passed as argument.

Status
colourYellow
titlecompatibility : universal

pressHome

pressHome

Presses the home button.

Status
colourYellow
titlecompatibility : universal

pressVolumeDown

pressVolumeDown

Presses the volume down button.

Status
colourYellow
titlecompatibility : universal

pressVolumeUp

pressVolumeUp

Presses the volume up button.

Status
colourYellow
titlecompatibility : universal

Excerpt
namefind

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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault rank : 1
Status
colourBlue
titleoptional rank
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault rank : 1
Status
colourBlue
titleoptional rank
Status
colourYellow
titlecompatibility : universal

findByClass

findById,[CLASS]

findById,[CLASS],[RANK]

Finds the nth element with the class selector. The element is saved as the last element found.

Status
titledefault rank : 1
Status
colourBlue
titleoptional rank
Status
colourYellow
titlecompatibility : universal

Excerpt
nameprobe

Probe

Command

Example

Description

measureStart

measureStart,CHRGT_home

Starts a measure which can be identified by the given name.

Status
colourYellow
titlecompatibility : universal

measureStop

Stops the current measure.

Status
colourYellow
titlecompatibility : universal

Excerpt
namescroll

Scroll

Command

Example

Description

scrollDownward

Scrolls downward the screen (only one scroll).

Status
colourYellow
titlecompatibility : universal

scrollUpward

Scrolls upward the screen (only one scroll).

Status
colourYellow
titlecompatibility : universal

scrollLeftward

Scrolls leftward the screen (only one scroll).

Status
colourYellow
titlecompatibility : universal

scrollRightward

Scrolls rightward the screen (only one scroll).

Status
colourYellow
titlecompatibility : 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).

Status
colourYellow
titlecompatibility : 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).

Status
colourYellow
titlecompatibility : 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%).

Status
titledefault percx : 50
Status
titledefault percstarty : 10
Status
colourBlue
titleoptional perc
Status
colourYellow
titlecompatibility : 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%).

Status
titledefault percx : 50
Status
titledefault percstarty : 90
Status
colourBlue
titleoptional perc
Status
colourYellow
titlecompatibility : 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).

Status
titledefault duration : 500
Status
colourBlue
titleoptional duration
Status
colourYellow
titlecompatibility : 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).

Status
titledefault duration : 500
Status
colourBlue
titleoptional duration
Status
colourYellow
titlecompatibility : 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%).

Status
colourGreen
titlecase-insensitive
Status
titledefault iterations : 10 (max 30)
Status
colourYellow
titlecompatibility : 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%).

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault iterations : 10 (max 30)
Status
titledefault percx: 50
Status
colourBlue
titleoptional iterations and percx
Status
colourYellow
titlecompatibility : universal

Excerpt
namesettext

Set Text

Command

Example

Description

setTextByText

setTextByText,[TEXT],[TEXT-SELECTOR]

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

Status
colourYellow
titlecompatibility : universal

setTextByTextExact

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

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

Status
colourYellow
titlecompatibility : 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

Status
colourBlue
titleoptional frequency
Status
colourYellow
titlecompatibility : universal

enterTextFast

enterTextFast,[TEXT]

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

Status
colourYellow
titlecompatibility : universal

Excerpt
nameWait Object

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.

Status
colourGreen
titleCASE-inSENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourGreen
titleCASE-inSENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
titledefault boolean : false
Status
colourBlue
titleoptional boolean
Status
colourYellow
titlecompatibility : 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.

Status
titledefault boolean : false
Status
colourBlue
titleoptional boolean
Status
colourGreen
titleCASE-inSENSITIVE
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault boolean : false
Status
colourBlue
titleoptional boolean
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault boolean : false
Status
colourBlue
titleoptional boolean
Status
colourYellow
titlecompatibility : 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.

Status
colourGreen
titleCASE-inSENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourGreen
titleCASE-inSENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourPurple
titleCASE-SENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : 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.

Status
colourGreen
titleCASE-inSENSITIVE
Status
titledefault timeout: 30000
Status
colourBlue
titleoptional timeout
Status
colourYellow
titlecompatibility : universal