io.appium.java_client.ios

Interface HasIOSSettings

All Superinterfaces:

ExecutesMethod, HasSettings

All Known Implementing Classes:

IOSDriver

public interface HasIOSSettings
extends HasSettings

Method Summary

Modifier and Type	Method and Description
default HasIOSSettings	nativeWebTap(java.lang.Boolean enabled) Set the `nativeWebTap` setting.
default HasIOSSettings	setElementResponseAttributes(java.lang.String attrNames) Which attributes should be returned if compact responses are disabled.
default HasIOSSettings	setKeyboardAutocorrection(boolean enabled) Changes the 'Auto-Correction' preference in Keyboards setting.
default HasIOSSettings	setKeyboardPrediction(boolean enabled) Changes the 'Predictive' preference in Keyboards setting.
default HasIOSSettings	setMjpegScalingFactor(int scale) The scale of screenshots in range 1..100.
default HasIOSSettings	setMjpegServerFramerate(int framerate) The frame rate at which the background screenshots broadcaster should broadcast screenshots in range 1..60.
default HasIOSSettings	setMjpegServerScreenshotQuality(int quality) The quality of the screenshots generated by the screenshots broadcaster, The value of 0 represents the maximum compression (or lowest quality) while the value of 100 represents the least compression (or best quality).
default HasIOSSettings	setScreenshotQuality(int quality) Changes the quality of phone display screenshots according to XCTest/XCTImageQuality enum.
default HasIOSSettings	setShouldUseCompactResponses(boolean enabled) Whether to return compact (standards-compliant) and faster responses from find element/s (the default setting).

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting, setSetting, setSettings, setSettings

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

Method Detail

nativeWebTap

default HasIOSSettings nativeWebTap(java.lang.Boolean enabled)

Set the `nativeWebTap` setting. *iOS-only method*. Sets whether Safari/webviews should convert element taps into x/y taps.

Parameters:

enabled - turns nativeWebTap on if true, off if false

Returns:

self instance for chaining

setShouldUseCompactResponses

default HasIOSSettings setShouldUseCompactResponses(boolean enabled)

Whether to return compact (standards-compliant) and faster responses from find element/s (the default setting). If set to false then the response may also contain other available element attributes.

Parameters:

enabled - Either true or false. The default value if true.

Returns:

self instance for chaining

setElementResponseAttributes

default HasIOSSettings setElementResponseAttributes(java.lang.String attrNames)

Which attributes should be returned if compact responses are disabled. It works only if shouldUseCompactResponses is set to false. Defaults to "type,label" string.

Parameters:

attrNames - The comma-separated list of fields to return with each element.

Returns:

self instance for chaining

setMjpegServerScreenshotQuality

default HasIOSSettings setMjpegServerScreenshotQuality(int quality)

The quality of the screenshots generated by the screenshots broadcaster, The value of 0 represents the maximum compression (or lowest quality) while the value of 100 represents the least compression (or best quality).

Parameters:

quality - An integer in range 0..100. The default value is 25.

Returns:

self instance for chaining

setMjpegServerFramerate

default HasIOSSettings setMjpegServerFramerate(int framerate)

The frame rate at which the background screenshots broadcaster should broadcast screenshots in range 1..60. The default value is 10 (Frames Per Second). Setting zero value will cause the frame rate to be at its maximum possible value.

Parameters:

framerate - An integer in range 1..60. The default value is 10.

Returns:

self instance for chaining

setScreenshotQuality

default HasIOSSettings setScreenshotQuality(int quality)

Changes the quality of phone display screenshots according to XCTest/XCTImageQuality enum. Sometimes setting this value to the maximum possible quality may crash XCTest because of lack of the memory (lossless screenshot require more space).

Parameters:

quality - An integer in range 0..2. The default value is 1.

Returns:

self instance for chaining

setMjpegScalingFactor

default HasIOSSettings setMjpegScalingFactor(int scale)

The scale of screenshots in range 1..100. The default value is 100, no scaling

Parameters:

scale - An integer in range 1..100. The default value is 100.

Returns:

self instance for chaining

setKeyboardAutocorrection

default HasIOSSettings setKeyboardAutocorrection(boolean enabled)

Changes the 'Auto-Correction' preference in Keyboards setting.

Parameters:

enabled - Either true or false. Defaults to false when WDA starts as xctest.

Returns:

self instance for chaining

setKeyboardPrediction

default HasIOSSettings setKeyboardPrediction(boolean enabled)

Changes the 'Predictive' preference in Keyboards setting.

Parameters:

enabled - Either true or false. Defaults to false when WDA starts as xctest.

Returns:

self instance for chaining