TextScreenTO

TerminalEmulators. TextScreenTO

ScreenTO

Constructor

new TextScreenTO()

A terminal emulator screen that uses text-only HLLAPI or does not support HLLAPI.

Methods

click(args[opt]) → {Promise.<void>}

Clicks on this object using the definitions from the supplied args object. If you do not provide the args object, the click is performed in the center of the object using the left mouse button.
Parameters:
NameTypeAttributesDescription
argsObject <optional>
The arguments for the click operation.
Properties
NameTypeAttributesDefaultDescription
buttonMouseButton <optional>
MouseButton.left The mouse button to use for the click.
anchorPosition <optional>
Position.center The position within the object from which the offset is taken.
offsetObject <optional>
The offset from the anchor position.
Properties
NameTypeAttributesDefaultDescription
xnumber <optional>
0 The x-coordinate of the offset.
ynumber <optional>
0 The y-coordinate of the offset.
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:
NameTypeDescription
positionObjectIf a Position object is passed, it will click on the position within the emulator screen.
Properties
NameTypeAttributesDescription
rownumber <optional>
The row position of the cursor in the emulator screen.
columnnumber <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:
NameTypeAttributesDescription
areaObject <optional>
If an Area object is passed, it will return the string from that location.
Properties
NameTypeAttributesDescription
topnumber <optional>
Top position of the rectangle.
leftnumber <optional>
Left position of the rectangle.
bottomnumber <optional>
Bottom position of the rectangle.
rightnumber <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:
NameTypeAttributesDefaultDescription
inputstring <optional>
The string to send to the object. Use FunctionKeys and Keys for special keys.
modifiersKeyModifier <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:
NameTypeAttributesDescription
millisecondsnumber <optional>
If a number is passed, it will wait 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:
NameTypeAttributesDescription
textstring | RegExpThe specified string or regular expression for which the emulator screen is waiting.
millisecondsnumber <optional>
If a number is passed, it will wait 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:
NameTypeAttributesDescription
textstring | RegExpThe specified string or regular expression for which the emulator screen is waiting.
areaObjectIf an Area object is passed, it will wait for text from that location.
If a number is passed, it will wait this number of milliseconds for a response..
Properties
NameTypeDescription
topnumberTop position of the rectangle.
leftnumberLeft position of the rectangle.
bottomnumberBottom position of the rectangle.
rightnumberRight position of the rectangle.
millisecondsnumber <optional>
If a number is passed, it will wait this number of milliseconds for a response.
Returns:
a promise that is fulfilled with the state of the specified inputs.
Type
Promise.<boolean>