Skip to content

iOS

Global object. Use it to perform actions not related to a particular object. You do not need to record or learn this object, it is always automatically available in any test.

Action Summary

Action Description
DoFlick Flick action.
DoGoToUrl Opens URL in active browser.
DoScreenshot Makes screenshot of a device.
DoShake Shakes device.
DoSwipe Swipe action.
DoTap Tap screen.
GetCapability Gets capability with specified name.
GetContext Gets current context.
GetDeviceOrientation Gets device orientation.
SetContext Sets context.
SetDeviceOrientation Sets device orientation.

Action Detail

DoFlick

Flick action.

iOS.DoFlick(endX, endY, startX, startY, touchCount)

Parameters:

Name Type Description
endX number x coordinate where swipe ends (in pixels or relative units)
endY number y coordinate where swipe ends (in pixels or relative units)
startX number x coordinate where swipe begins (in pixels or relative units)
Optional.
startY number y coordinate where swipe begins (in pixels or relative units)
Optional.
touchCount number how many fingers to swipe with
Optional.

Returns:

'true' if successful, 'false' otherwise.

DoGoToUrl

Opens URL in active browser.

iOS.DoGoToUrl(url)

Parameters:

Name Type Description
url string

Returns:

'true' if successful, 'false' otherwise.

DoScreenshot

Makes screenshot of a device.

iOS.DoScreenshot(txtLabel)

Parameters:

Name Type Description
txtLabel string Label of a screenshot in the report.
Optional.

Returns:

'true' if successful, 'false' otherwise.

DoShake

Shakes device.

iOS.DoShake()

Returns:

'true' if successful, 'false' otherwise.

DoSwipe

Swipe action.

iOS.DoSwipe(endX, endY, startX, startY, duration, touchCount)

Parameters:

Name Type Description
endX number x coordinate where swipe ends (in pixels or relative units)
endY number y coordinate where swipe ends (in pixels or relative units)
startX number x coordinate where swipe begins (in pixels or relative units)
Optional.
startY number y coordinate where swipe begins (in pixels or relative units)
Optional.
duration number time (in seconds) to spend performing the swipe/drag
Optional.
touchCount number how many fingers to swipe with
Optional.

Returns:

'true' if successful, 'false' otherwise.

DoTap

Tap screen.

iOS.DoTap(x, y, duration, tapCount, touchCount)

Parameters:

Name Type Description
x number x coordinate to tap (in pixels or relative units)
Optional.
y number y coordinate to tap (in pixels or relative units)
Optional.
duration number how long (in seconds) to tap
Optional.
tapCount number how many times to tap
Optional.
touchCount number how many fingers to tap with
Optional.

Returns:

'true' if successful, 'false' otherwise.

GetCapability

Gets capability with specified name.

iOS.GetCapability(name)

Parameters:

Name Type Description
name string Name of a capability.

Returns:

Capability string.

GetContext

Gets current context.

iOS.GetContext()

Returns:

Either NATIVE_APP or WEBVIEW_1.

GetDeviceOrientation

Gets device orientation.

iOS.GetDeviceOrientation()

Returns:

Device orientation.

SetContext

Sets context.

iOS.SetContext(name)

Parameters:

Name Type Description
name string Either NATIVE_APP or WEBVIEW_1.

SetDeviceOrientation

Sets device orientation.

iOS.SetDeviceOrientation(orientation)

Parameters:

Name Type Description
orientation number ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE

Returns:

Device orientation.