ApplicationTO

Mobile. ApplicationTO

ApplicationTO

Constructor

new ApplicationTO()

A mobile application.

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not cause LeanFT to search for the object in the AUT. LeanFT interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
Name Type Description
description Description The description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.
Returns:
the new child test object with the provided description.
Type
*

$$(description, dontFilterByType[opt] ) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByType boolean <optional>
false Set this parameter to true to avoid limiting the returned objects to a specific test object type.
Returns:
a promise that is fulfilled with an array of test objects that match the supplied description.
Type
Promise.<Array.<TestObject>>

description() → {*}

Returns the description for this test object. The test object must be obtained using the $ method, otherwise, this method returns null.
Returns:
the description for this test object.
Type
*

getTextLocations(text, rectangle[opt] ) → {Promise.<Object>}

Returns all rectangular areas containing the specified text within this object.
Parameters:
Name Type Attributes Description
text string The text to search for in the test object.
rectangle Object <optional>
The rectangular area in the test object to search for the text.
Returns:
a promise that is fulfilled with an array of rectangles containing all rectangular areas containing the specified text within this object.
Type
Promise.<Object>

getVisibleText(rectangle[opt] ) → {Promise.<string>}

Returns all visible text from this object.
Parameters:
Name Type Attributes Description
rectangle Object <optional>
The rectangular area in the test object to return the text from.
Returns:
a promise that is fulfilled with all the visible text from this object.
Type
Promise.<string>

highlightMatches(description, dontFilterByType[opt] ) → {Promise.<number>}

Highlights all children that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByType boolean <optional>
false Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.
Returns:
a promise that is fulfilled with the number of matches that are found and highlighted.
Type
Promise.<number>

identifier() → {Promise.<string>}

Returns the application identifier string.
Returns:
a promise that is fulfilled with the application identifier string.
Type
Promise.<string>

install() → {Promise.<void>}

Installs (or re-installs) the application and then launches it.
Returns:
a promise that is fulfilled when the application is installed (or re-installed).
Type
Promise.<void>

isPackaged() → {Promise.<boolean>}

Indicates whether the application is packaged.
Returns:
a promise that is fulfilled with an indication of whether the application is packaged.
Type
Promise.<boolean>

kill() → {Promise.<void>}

Stops the application.
Returns:
a promise that is fulfilled when the application is stopped.
Type
Promise.<void>

launch() → {Promise.<void>}

Launches the application if it is not already running.
Returns:
a promise that is fulfilled when the application is launched.
Type
Promise.<void>

name() → {Promise.<string>}

Returns the name of the mobile application.
Returns:
a promise that is fulfilled with the name of the mobile application.
Type
Promise.<string>

parent() → {*}

Returns the parent test object of this test object. The child object must be obtained using the $ method, otherwise, this method returns null.
Returns:
the parent test object of this test object.
Type
*

restart() → {Promise.<void>}

Launches the application if it is closed, or restarts the application if it is already running.
Returns:
a promise that is fulfilled when the application is launched or restarted.
Type
Promise.<void>

simulateAuthCancel(origin) → {Promise.<void>}

Simulates authentication cancelling with specific origin.
Parameters:
Name Type Description
origin Mobile.SimulateAuthCancelOrigin the cancellation origin.
Returns:
a promise that is fulfilled when the authentication simulation ends.
Type
Promise.<void>

simulateAuthFail(reason) → {Promise.<void>}

Simulates authentication failure with specific reason.
Parameters:
Name Type Description
reason Mobile.SimulateAuthFailReason the reason of the authentication failure.
Returns:
a promise that is fulfilled when the authentication simulation ends.
Type
Promise.<void>

simulateAuthSucceed() → {Promise.<void>}

Simulates authentication success.
Returns:
a promise that is fulfilled when the authentication simulation ends.
Type
Promise.<void>

simulateBarcodeScan(mediaId) → {Promise.<void>}

Simulate barcode or QR code scan using an image file. Run after Device.UploadMedia.
Parameters:
Name Type Description
mediaId string The unique ID of the uploaded image to use in the simulation as used in IDevice.UploadMedia.
Returns:
a promise that is fulfilled when the simulation of barcode or QR code scan using an image file ends.
Type
Promise.<void>

startCameraSimulationMode(mediaId) → {Promise.<void>}

Start camera simulation mode. Run after Device.uploadMediaUrl. Once simulation is completed, run stopCameraSimulationMode.
Parameters:
Name Type Description
mediaId string The unique ID of the uploaded media to use in the simulation, as used in Device.uploadMediaUrl.
Returns:
a promise that is fulfilled when the application enters camera simulation mode.
Type
Promise.<void>

stopCameraSimulationMode() → {Promise.<void>}

Stop camera simulation mode.
Returns:
a promise that is fulfilled when the application leaves camera simulation mode.
Type
Promise.<void>

uninstall() → {Promise.<void>}

Uninstalls the application.
Returns:
a promise that is fulfilled when the application is uninstalled.
Type
Promise.<void>

upload() → {Promise.<boolean>}

The application upload number. The upload number can be used to identify the application uniquely when the application is uploaded more than once.
Returns:
a promise that is fulfilled with the application upload number.
Type
Promise.<boolean>

verifyImageExists(imageToFind, similarity[opt] ) → {Promise.<Object>}

Checks whether a snapshot of this object contains the supplied image.
Parameters:
Name Type Attributes Description
imageToFind string A Base64 string representation of the image to look for within the test object's snapshot.
similarity number <optional>
The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.
Returns:
a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.
Type
Promise.<Object>

verifyImageMatch(expectedImage, pixelTolerance[opt] , rgbTolerance[opt] ) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
Name Type Attributes Description
expectedImage string A Base64 string representation of the image to compare to the test object snapshot.
pixelTolerance number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>

verifyImageMatchWithMask(expectedImage, maskAreaImage, pixelTolerance[opt] , rgbTolerance[opt] ) → {Promise.<boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
Name Type Attributes Description
expectedImage string A Base64 string representation of the image to compare to the test object snapshot.
maskAreaImage string A Base64 string representation of the image mask area to use in the image comparison.
pixelTolerance number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a promise that is fulfilled with a boolean representing the comparison result.
Type
Promise.<boolean>

version() → {Promise.<string>}

Returns the application version.
Returns:
a promise that is fulfilled with the application version.
Type
Promise.<string>

waitUntilExists(timeout[opt] ) → {Promise.<boolean>}

Waits until this test object exists or until the specified timeout elapses. This method is useful for synchronizing your test with your application.
Parameters:
Name Type Attributes Description
timeout number <optional>
The time (in milliseconds) to wait for this object to exist.
By default, uses the object synchronization timeout defined in the runtime engine settings.
Returns:
a promise that is fulfilled with a boolean indicating whether the object exists.
Type
Promise.<boolean>