Locators:

• /XPATH - Locates element using an XPath 1.0 expression.

• ~AccessibilityId - Locates element by its Accessibility ID. Attribute name in inspect.exe - AutomationId.

• name=NAME - Locates element by its name. Attribute name in inspect.exe - Name.

• id=ID - Locates element by its ID. Attribute name in inspect.exe - RuntimeID.

Pattern arguments:

Commands which expect a string matching pattern in their arguments, support following patterns unless specified otherwise:

• regex:PATTERN - Match using regular expression.

• PATTERN - Verbatim matching.

assertText

Asserts element's inner text.

Text pattern can be any of the supported string matching patterns(on the top of page). If the element is not interactable, then it will allways return empty string as its text.

Parameters:

assertTitle

Asserts the page title.

Assertion pattern can be any of the supported string matching patterns(on the top of page).

Parameters:

assertValue

Asserts element's value.

Parameters:

back

Navigate backwards in the browser history or simulates back button on Android device.

clear

Clears element's value or content

Parameters:

click

Clicks on an element.

Parameters:

clickLong

Performs a long click/touch on an element.

Parameters:

clickMultipleTimes

Performs tap on an element multiple times in quick succession.

Parameters:

dispose

Ends the current session.

findElement

Finds an element.

Parameters:

Returns:

Element - A Element object.

findElements

Finds elements.

Parameters:

Returns:

Array.<Element> - Collection of Element objects.

getAppiumLogs

Collects logs from the Appium server.

Returns:

Array.<Object> - A list of logs.

getCapabilities

Returns currently defined capabilities.

Returns:

Object - Current capabilities object.

getCurrentWindowHandle

Gets current window handle.

Usage example:

win.init();
win.getCurrentWindowHandle();

Returns:

String - A window handle.

getDriver

Returns the underlying WDIO driver.

Returns:

Object - WDIO driver.

getLocation

Get element's location.

Parameters:

Returns:

Object - X and Y location of the element relative to top-left page corner.

getSource

Gets the source code of the page.

Returns:

String - HTML in case of web or hybrid application or XML in case of native.

getText

Returns the text (rendered text shown to the user; whitespace-trimmed) of an element.

Parameters:

Returns:

String - Element's text.

getValue

Gets element's value (whitespace-trimmed).

Parameters:

Returns:

String - Element's value.

getWindowHandles

Gets handles of currently open windows.

Usage example:

win.init();//Opens WinAppDriver session.
win.getWindowHandles();//Gets the window handles of currently open application.

Returns:

Array.<String> - Array of all available window handles.

init

Initializes a new Appium session.

Parameters:

isCheckable

Determines if checkbox or radio element is checkable.

Parameters:

Returns:

Boolean - true if element is checkable. false otherwise.

isChecked

Determines if checkbox or radio element is checked.

Parameters:

Returns:

Boolean - true if element is checked. false otherwise.

isClickable

Determines if an element is clickable.

Parameters:

Returns:

Boolean - true if element is clickable. false otherwise.

isExist

Wait for an element to become available.

The element is not necessary needs to be visible.

Parameters:

Returns:

Boolean - true if the element exists. false otherwise.

isSelected

Determines if an element is selected.

Parameters:

Returns:

Boolean - true if element is selected. false otherwise.

isVisible

Checks if element is present and visible. Returns false if element was not found or wasn't visible within the specified timeout.

Parameters:

Returns:

Boolean - True if element was found and it was visible. False otherwise.

open

Opens an URL.

The open command waits for the page to load before proceeding.

Parameters:

pause

Pauses test execution for given amount of milliseconds.

Parameters:

rightClick

Perform right click on an element.

Parameters:

selectWindow

Selects window. Once window has been selected, all commands go to that window.

windowLocator can be:

• title=TITLE - Switch to the first window which matches the specified title. TITLE can be any of the supported string matching patterns. When using title locator, this command will wait for the window to appear first similarly to waitForWindow command.

• windowHandle - Switch to a window using its unique handle.

• unspecified - Switch to the last opened window.

Usage example:

win.init();//Opens browser session.
win.open("www.yourwebsite.com");// Opens a website.
win.selectWindow("title=Website");// Selects and focus a window.

Parameters:

Returns:

String - windowHandle of the previously selected window.

sendKeys

Send a sequence of keyboard strokes to the active window or element.

Refer to Key Codes for the list of supported raw keyboard key codes.

Usage example:

win.init();//Opens browser session.
win.open("www.yourwebsite.com");// Opens a website.
win.sendKeys("Hello World");
win.sendKeys(["Backspace", "Backspace", "Enter"]); // send two Backspace key codes and Enter.
// Unicode representation can be used directly as well:
win.sendKeys("Hello World\uE003\uE003\uE007");

Parameters:

setTimeout

Specifies the amount of time that Oxygen will wait for actions to complete.

This includes the open command, waitFor* commands, and commands which wait for elements to appear in DOM or become visible before operating on them. If command wasn't able to complete within the specified period it will fail the test. The default time-out is 60 seconds.

Parameters:

takeScreenshot

Take a screenshot of the current page or screen and return it as base64 encoded string.

Usage example:

win.init(caps);
var ss = win.takeScreenshot();//Take a screenshot and return it as base64 encoded string.
require("fs").writeFileSync("c:\\screenshot.png", ss, 'base64');

Returns:

String - Screenshot image encoded as a base64 string.

tap

Perform tap at the specified coordinate.

Parameters:

transaction

Opens new transaction.

The transaction will persist till a new one is opened. Transaction names must be unique.

Parameters:

type

Send a sequence of key strokes to an element (clears value before).

Refer to Key Codes for the list of supported raw keyboard key codes.

Parameters:

waitForExist

Wait for an element for the provided amount of milliseconds to exist in DOM.

The element is not necessary needs to be visible.

Parameters:

waitForVisible

Waits for element to become visible.

Parameters: