Package io.appium.java_client.driverscripts

Class ScriptOptions

  • public class ScriptOptions
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptOptions()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.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 Detail

      • ScriptOptions

        public ScriptOptions()

    • Method Detail

      • 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 java.util.Map<java.lang.String,​java.lang.Object> build()
        Builds a values map for further usage in HTTP requests to Appium.
        Returns:
        The map containing the provided options