Quick Reference: Eggplant Functional Functions

The following table lists common SenseTalk functions that you can use with Eggplant Functional scripts.

Function

Returns

ColorAtLocation

The color of the pixel at a given location (Default: RGB value)

ConnectionInfo

A connection property list

EggPlantVersion

The version number of your copy of Eggplant Functional

EveryImageLocation

The hot spot location of every occurrence of the given image or images

EveryImageRectangle

Rectangle coordinates of every occurrence of the given image or images

FoundImageInfo

An image property list for the last image found

FoundImageLocation

The location of the last image found

FoundImageName()

(Deprecated. See foundImageInfo().) Name of the last image found.

FoundImageNumber

The position of the last image found, within a series of given images

GetOption

The value of a given global property

GetOptions

The values of all Run Option global properties or given global properties

ImageColorAtLocation

The color of the pixel at a given location within an image (Default: RGB value)

ImageFound

Whether a given image is found; True or false

ImageHotSpot

The location of the hot spot in the given image

ImageInfo

An image property list for the given image

ImageLocation

The hot spot location of the first occurrence of the given image or images

ImageRectangle

The rectangle coordinates of the first occurrence of the given image or images

ImageSize

An image width and height in pixels

AllConnectionInfo

A list of connection property lists for every SUT in the Connection List

MouseLocation

Coordinates of the current mouse cursor location

OpenSuites

A list of all suites available to the current script

ReadCharacters Returns a character from a character collection as a string or multiline string

ReadTable

The table data found within a given rectangle on the SUT

ReadText

Uses OCR to read the text content found within a given rectangle on the SUT

RemoteClipboard

Contents of the SUT clipboard

RemoteScreenRectangle

The coordinates of a rectangle the size of the entire Viewer window

RemoteScreenSize

The width and height of the Viewer window in pixels

RunningFromCommandLine

Whether or not the current script run was called in a command line

ScriptResults

A results property list for every run of the given (or current) script

SuiteInfo

A property list of information about the given suite (or current suite)

Deprecated Functions

Functions in the following table are deprecated and no longer supported; if an updated command or method is available, it is noted in the description.

Function

Behavior and Alternatives

ADBCall Executes ADB calls to available Android devices and returns any output. Instead, use the equivalent ADBCallRemote function.
FoundImageName Returns the name of the last image found. Instead, use the FoundImageInfo function, which returns the imageName or imagePath as a parameter.

 

This topic was last updated on September 07, 2020, at 09:39:31 AM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2020 Eggplant