Package io.appium.java_client.driverscripts

Class ScriptOptions

java.lang.Object

io.appium.java_client.driverscripts.ScriptOptions

public class ScriptOptions
extends Object

Constructor Summary

Constructors

Constructor	Description
ScriptOptions()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	build()	Builds a values map for further usage in HTTP requests to Appium.
ScriptOptions	withScriptType(ScriptType type)	Sets the script type.
ScriptOptions	withTimeout(long timeoutMs)	Sets the script execution timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptOptions

public ScriptOptions()

Method Details

withScriptType

public ScriptOptions withScriptType(ScriptType type)

Sets the script type.

Parameters:

type - the actual script type

Returns:

self instance for chaining

withTimeout

public ScriptOptions withTimeout(long timeoutMs)

Sets the script execution timeout. If this is not set then the maximum duration of the script is not limited (e. g. may block forever).

Parameters:

timeoutMs - the timeout in milliseconds

Returns:

self instance for chaining

build

public Map<String,Object> build()

Builds a values map for further usage in HTTP requests to Appium.

Returns:

The map containing the provided options