Methods

click(args_opt) → {Promise.<void>}

Parameters:

Returns:

a promise that is fulfilled when the click operation ends.

Type

Promise.<void>

clickPosition(position) → {Promise.<void>}

Clicks the specified row and column position on the emulator screen.

Parameters:

Name	Type	Description
position	Object	If a Position object is passed, the method clicks on the position within the emulator screen. Properties Name Type Attributes Description row number <optional> The row position of the cursor in the emulator screen. column number <optional> The column position of the cursor in the emulator screen.

Returns:

a promise that is fulfilled when the clickPosition operation ends.

Type

Promise.<void>

getText(area_opt) → {Promise.<string>}

Returns the text from the specified screen rectangle.

Parameters:

Name	Type	Attributes	Description
area	Object	<optional>	If an Area object is passed, the method returns the string from that location. Properties Name Type Attributes Description top number <optional> Top position of the rectangle. left number <optional> Left position of the rectangle. bottom number <optional> Bottom position of the rectangle. right number <optional> Right position of the rectangle.

Returns:

a promise that is fulfilled with the contents of the specified text.

Type

Promise.<string>

sendKeys(input_opt, modifiers_opt) → {Promise.<void>}

Sends keyboard keys to an object.

Parameters:

Name	Type	Attributes	Default	Description
input	string	<optional>		The string to send to the object. Use FunctionKeys and Keys for special keys.
modifiers	KeyModifier	<optional>	KeyModifier.none	The modifier keys. Use KeyModifier for this parameter.

Returns:

a promise that is fulfilled when the sendKeys operation ends.

Type

Promise.<void>

size() → {Promise.<Object>}

The terminal emulator screen column count and row count.

Returns:

a promise that is fulfilled with the object's size.

Type

Promise.<Object>

sync(milliseconds_opt) → {Promise.<void>}

Waits until a response is received from the host and the emulator status is set to Ready, or until the timeout is reached, before continuing with the run session.

Parameters:

Name	Type	Attributes	Description
milliseconds	number	<optional>	If a number is passed, the method waits this number of milliseconds for a response.

Returns:

a promise that is fulfilled when the sync operation ends.

Type

Promise.<void>

waitForText(text, milliseconds_opt) → {Promise.<boolean>}

Waits for specific text to appear on the emulator screen before continuing the run session.

Example 1:
Use the waitForText method to wait 10 seconds for the string "CH70001 LAST ACCESS AT 14:27:07 ON THURSDAY", where this string is defined as a regular expression:
waitForText(new RegExp(".*LAST ACCESS AT \d\d:\d\d:\d\d ON .*DAY.*"), 10000)

Example 2:
Use the waitForText method to wait 5 seconds for the string "User":
waitForText("User", 5000)

Parameters:

Name	Type	Attributes	Description
text	string | RegExp		The specified string or regular expression for which the emulator screen is waiting.
milliseconds	number	<optional>	If a number is passed, the method waits this number of milliseconds for a response.

Returns:

a promise that is fulfilled with the state of the specified inputs.

Type

Promise.<boolean>

waitForTextInArea(text, area, milliseconds_opt) → {Promise.<boolean>}

Waits for specific text to appear on the emulator screen before continuing the run session.

Example 1:
Use the waitForText method to wait 10 seconds for the string, "CH70001 LAST ACCESS AT 14:27:07 ON THURSDAY", where this string is defined as a regular expression:
waitForText(new RegExp(".*LAST ACCESS AT \d\d:\d\d:\d\d ON .*DAY.*"), {top: 6, left: 53, bottom: 6, right: 60}, 10000)

Example 2:
Use the waitForText method to wait 5 seconds for the string User":
waitForText("User", {top: 6, left: 53, bottom: 6, right: 60}, 5000)

Parameters:

Name	Type	Attributes	Description
text	string | RegExp		The specified string or regular expression for which the emulator screen is waiting.
area	Object		If an Area object is passed, the method waits for text from that location. If a number is passed, the method waits this number of milliseconds for a response. Properties Name Type Description top number Top position of the rectangle. left number Left position of the rectangle. bottom number Bottom position of the rectangle. right number Right position of the rectangle.
milliseconds	number	<optional>	If a number is passed, the method waits this number of milliseconds for a response.

Returns:

a promise that is fulfilled with the state of the specified inputs.

Type

Promise.<boolean>