Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use ScriptOptions class of io.appium.java_client.driverscripts package

Best io.appium code snippet using io.appium.java_client.driverscripts.ScriptOptions

ExecutesDriverScript.java

Source:ExecutesDriverScript.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client;17import io.appium.java_client.driverscripts.ScriptOptions;18import io.appium.java_client.driverscripts.ScriptValue;19import org.openqa.selenium.remote.Response;20import javax.annotation.Nullable;21import java.util.HashMap;22import java.util.Map;23import static com.google.common.base.Preconditions.checkNotNull;24import static io.appium.java_client.MobileCommand.EXECUTE_DRIVER_SCRIPT;25public interface ExecutesDriverScript extends ExecutesMethod {26    /**27     * Run a set of scripts in scope of the current session.28     * This allows multiple web driver commands to be executed within one request29     * and may significantly speed up the automation script performance in30     * distributed client-server environments with high latency.31     * Read http://appium.io/docs/en/commands/session/execute-driver for more details.32     *33     * @since Appium 1.1434     * @param script the web driver script to execute (it should35     *               be a valid webdriverio code snippet by default36     *               unless another option is provided)37     * @param options additional scripting options38     * @return The script result39     * @throws org.openqa.selenium.WebDriverException if there was a failure while executing the script40     */41    default ScriptValue executeDriverScript(String script, @Nullable ScriptOptions options) {42        Map<String, Object> data = new HashMap<>();43        data.put("script", checkNotNull(script));44        if (options != null) {45            data.putAll(options.build());46        }47        Response response = execute(EXECUTE_DRIVER_SCRIPT, data);48        //noinspection unchecked49        Map<String, Object> value = (Map<String, Object>) response.getValue();50        //noinspection unchecked51        return new ScriptValue(value.get("result"), (Map<String, Object>) value.get("logs"));52    }53    /**54     * Run a set of scripts in scope of the current session with default options.55     *...

ScriptOptions.java

Source:ScriptOptions.java

...17import com.google.common.collect.ImmutableMap;18import java.util.Map;19import static com.google.common.base.Preconditions.checkNotNull;20import static java.util.Optional.ofNullable;21public class ScriptOptions {22    private ScriptType scriptType;23    private Long timeoutMs;24    /**25     * Sets the script type.26     *27     * @param type the actual script type28     * @return self instance for chaining29     */30    public ScriptOptions withScriptType(ScriptType type) {31        this.scriptType = checkNotNull(type);32        return this;33    }34    /**35     * Sets the script execution timeout.36     * If this is not set then the maximum duration of the script37     * is not limited (e. g. may block forever).38     *39     * @param timeoutMs the timeout in milliseconds40     * @return self instance for chaining41     */42    public ScriptOptions withTimeout(long timeoutMs) {43        this.timeoutMs = timeoutMs;44        return this;45    }46    /**47     * Builds a values map for further usage in HTTP requests to Appium.48     *49     * @return The map containing the provided options50     */51    public Map<String, Object> build() {52        final ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();53        ofNullable(scriptType).map(x -> builder.put("type", x.name().toLowerCase()));54        ofNullable(timeoutMs).map(x -> builder.put("timeout", x));55        return builder.build();56    }...

ExecuteDriverScriptTest.java

Source:ExecuteDriverScriptTest.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client.android;17import io.appium.java_client.driverscripts.ScriptOptions;18import io.appium.java_client.driverscripts.ScriptType;19import io.appium.java_client.driverscripts.ScriptValue;20import org.junit.Test;21import java.util.Arrays;22import java.util.List;23import java.util.Map;24import static org.hamcrest.Matchers.equalTo;25import static org.hamcrest.core.Is.is;26import static org.junit.Assert.assertNotNull;27import static org.junit.Assert.assertThat;28public class ExecuteDriverScriptTest extends BaseAndroidTest {29    @Test30    public void verifyBasicScriptExecution() {31        String script = String.join("\n", Arrays.asList(32                "const status = await driver.status();",33                "console.warn('warning message');",34                "return status;")35        );36        ScriptValue value = driver.executeDriverScript(script, new ScriptOptions()37                .withTimeout(5000)38                .withScriptType(ScriptType.WEBDRIVERIO));39        //noinspection unchecked40        assertNotNull(((Map<String, Object>) value.getResult()).get("build"));41        //noinspection unchecked42        assertThat(((List<String>)value.getLogs().get("warn")).get(0),43                is(equalTo("warning message")));44    }45}...

SessionCommands.java

Source:SessionCommands.java

...4import org.openqa.selenium.ScreenOrientation;5import org.openqa.selenium.TakesScreenshot;6import org.openqa.selenium.html5.Location;7import io.appium.java_client.Setting;8import io.appium.java_client.driverscripts.ScriptOptions;9import io.appium.java_client.serverevents.CustomEvent;10import util.Common.BaseClass;11public class SessionCommands  extends BaseClass{12	public void allCommands() {13		driver.quit(); // End Session14		driver.getSessionDetails(); // Get Session Capabilities15		//driver.back(); // Go Back16		((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE); // Take Screenshot17		driver.getPageSource(); //Get Page Source18		driver.manage().timeouts().pageLoadTimeout(30, TimeUnit.SECONDS); // Set Timeouts19		driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS); // Set Implicit Wait Timeout20		driver.manage().timeouts().setScriptTimeout(30, TimeUnit.SECONDS); // Set Script Timeout21		driver.getOrientation(); // Get Orientation22		driver.rotate(ScreenOrientation.LANDSCAPE); // Set Orientation23		driver.location(); // Get Geolocation24		driver.setLocation(new Location(49, 123, 10)); // Set Geolocation25		driver.manage().logs().getAvailableLogTypes(); // Get available log types26		driver.manage().logs().get("driver"); // Get Logs27		CustomEvent evt = new CustomEvent();28		evt.setEventName("funEvent");29		evt.setVendor("appium");30		driver.logEvent(evt); // Log event31		driver.getEvents(); // Get events32		driver.setSetting(Setting.WAIT_FOR_IDLE_TIMEOUT, 5000); // Update Device Settings33		driver.getSettings(); // Retrieve Device Settings34		String script = "const el = await driver.$('~foo');\n"+"await el.click();";35		driver.executeDriverScript(script, new ScriptOptions().withTimeout(200));36		// Execute Driver Script37	}38}...

ScriptOptions

Using AI Code Generation

1import java.util.HashMap;2import java.util.Map;3import org.openqa.selenium.remote.DesiredCapabilities;4import io.appium.java_client.AppiumDriver;5import io.appium.java_client.android.AndroidDriver;6import io.appium.java_client.ios.IOSDriver;7import io.appium.java_client.remote.MobileCapabilityType;8import io.appium.java_client.remote.MobilePlatform;9import io.appium.java_client.remote.AutomationName;10import io.appium.java_client.driverscripts.ScriptOptions;11public class AppiumDriverScript {12    public static void main(String[] args) throws Exception {13        DesiredCapabilities capabilities = new DesiredCapabilities();14        capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);15        capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");16        capabilities.setCapability(MobileCapabilityType.AUTOMATION_NAME, AutomationName.APPIUM);

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions();2scriptOptions.addAdditionalCapability("key", "value");3driver.executeScript("mobile: script", scriptOptions);4ScriptOptions scriptOptions = new ScriptOptions();5scriptOptions.addAdditionalCapability("key", "value");6driver.executeScript("mobile: script", scriptOptions);7ScriptOptions scriptOptions = new ScriptOptions();8scriptOptions.addAdditionalCapability("key", "value");9driver.executeScript("mobile: script", scriptOptions);10ScriptOptions scriptOptions = new ScriptOptions();11scriptOptions.addAdditionalCapability("key", "value");12driver.executeScript("mobile: script", scriptOptions);13ScriptOptions scriptOptions = new ScriptOptions();14scriptOptions.addAdditionalCapability("key", "value");15driver.executeScript("mobile: script", scriptOptions);16ScriptOptions scriptOptions = new ScriptOptions();17scriptOptions.addAdditionalCapability("key", "value");18driver.executeScript("mobile: script", scriptOptions);19ScriptOptions scriptOptions = new ScriptOptions();20scriptOptions.addAdditionalCapability("key", "value");21driver.executeScript("mobile: script", scriptOptions);22ScriptOptions scriptOptions = new ScriptOptions();23scriptOptions.addAdditionalCapability("key", "value");24driver.executeScript("mobile: script", scriptOptions);25ScriptOptions scriptOptions = new ScriptOptions();26scriptOptions.addAdditionalCapability("key", "value");27driver.executeScript("mobile: script", scriptOptions);

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions();2scriptOptions.withArguments("--script-args", "arg1", "arg2");3driver.executeScript("mobile:script", scriptOptions);4ScriptOptions scriptOptions = new ScriptOptions();5scriptOptions.withArguments("--script-args", "arg1", "arg2");6driver.executeScript("mobile:script", scriptOptions);7ScriptOptions scriptOptions = new ScriptOptions();8scriptOptions.withArguments("--script-args", "arg1", "arg2");9driver.executeScript("mobile:script", scriptOptions);10ScriptOptions scriptOptions = new ScriptOptions();11scriptOptions.withArguments("--script-args", "arg1", "arg2");12driver.executeScript("mobile:script", scriptOptions);13ScriptOptions scriptOptions = new ScriptOptions();14scriptOptions.withArguments("--script-

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions().withTimeout(5, TimeUnit.SECONDS);2driver.executeScript("mobile: shell", scriptOptions);3script_options = ScriptOptions().withTimeout(5, TimeUnit.SECONDS)4driver.execute_script("mobile: shell", script_options)5const scriptOptions = new ScriptOptions().withTimeout(5, TimeUnit.SECONDS);6driver.executeScript("mobile: shell", scriptOptions);7script_options = Appium::Core::Base::ScriptOptions.new.timeout(5, TimeUnit.SECONDS)8driver.execute_script("mobile: shell", script_options)9$scriptOptions = new ScriptOptions()->withTimeout(5, TimeUnit.SECONDS);10$driver->executeScript("mobile: shell", $scriptOptions);11var scriptOptions = new ScriptOptions().WithTimeout(5, TimeUnit.SECONDS);12driver.ExecuteScript("mobile: shell", scriptOptions);13var scriptOptions = new ScriptOptions().WithTimeout(5, TimeUnit.SECONDS);14driver.ExecuteScript("mobile: shell", scriptOptions);15script_options = Appium::Core::Base::ScriptOptions.new.timeout(5, TimeUnit.SECONDS)16driver.execute_script("mobile: shell", script_options)17script_options = Appium::Core::Base::ScriptOptions.new.timeout(5, TimeUnit.SECONDS)18driver.execute_script("mobile: shell", script_options)19script_options = ScriptOptions().withTimeout(5, TimeUnit.SECONDS)20driver.execute_script("mobile: shell", script_options)

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions();2scriptOptions.addAdditionalCapability("scriptName", "test");3scriptOptions.addAdditionalCapability("scriptExtension", "js");4driver.executeScript("mobile: script", scriptOptions);5ScriptOptions scriptOptions = new ScriptOptions();6scriptOptions.addAdditionalCapability("scriptName", "test");7scriptOptions.addAdditionalCapability("scriptExtension", "js");8driver.executeScript("mobile: script", scriptOptions);9ScriptOptions scriptOptions = new ScriptOptions();10scriptOptions.addAdditionalCapability("scriptName", "test");11scriptOptions.addAdditionalCapability("scriptExtension", "js");12driver.executeScript("mobile: script", scriptOptions);13ScriptOptions scriptOptions = new ScriptOptions();14scriptOptions.addAdditionalCapability("scriptName", "test");15scriptOptions.addAdditionalCapability("scriptExtension", "js");16driver.executeScript("mobile: script", scriptOptions);17ScriptOptions scriptOptions = new ScriptOptions();18scriptOptions.addAdditionalCapability("scriptName", "test");19scriptOptions.addAdditionalCapability("scriptExtension", "js");20driver.executeScript("mobile: script", scriptOptions);21ScriptOptions scriptOptions = new ScriptOptions();22scriptOptions.addAdditionalCapability("scriptName", "test");23scriptOptions.addAdditionalCapability("scriptExtension", "js");24driver.executeScript("mobile: script", scriptOptions);25ScriptOptions scriptOptions = new ScriptOptions();26scriptOptions.addAdditionalCapability("scriptName", "test");27scriptOptions.addAdditionalCapability("scriptExtension", "js");28driver.executeScript("mobile: script", scriptOptions);29ScriptOptions scriptOptions = new ScriptOptions();30scriptOptions.addAdditionalCapability("scriptName", "test");31scriptOptions.addAdditionalCapability("scriptExtension", "js");

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions();2scriptOptions.withArguments("--script", "path/to/script.js");3driver.executeScript("mobile:executeDriverScript", scriptOptions);4ScriptOptions scriptOptions = new ScriptOptions();5scriptOptions.withArguments("--script", "path/to/script.js");6driver.executeScript("mobile:executeDriverScript", scriptOptions);7ScriptOptions scriptOptions = new ScriptOptions();8scriptOptions.withArguments("--script", "path/to/script.js");9driver.executeScript("mobile:executeDriverScript", scriptOptions);10ScriptOptions scriptOptions = new ScriptOptions();11scriptOptions.withArguments("--script", "path/to/script.js");12driver.executeScript("mobile:executeDriverScript", scriptOptions);13ScriptOptions scriptOptions = new ScriptOptions();14scriptOptions.withArguments("--script", "path/to/script.js");15driver.executeScript("mobile:executeDriverScript", scriptOptions);16ScriptOptions scriptOptions = new ScriptOptions();17scriptOptions.withArguments("--script", "path/to/script.js");18driver.executeScript("mobile:executeDriverScript", scriptOptions);19ScriptOptions scriptOptions = new ScriptOptions();20scriptOptions.withArguments("--script", "path/to/script.js");21driver.executeScript("mobile:executeDriverScript", scriptOptions);22ScriptOptions scriptOptions = new ScriptOptions();23scriptOptions.withArguments("--script", "path/to/script.js");24driver.executeScript("mobile:executeDriverScript", scriptOptions);25ScriptOptions scriptOptions = new ScriptOptions();26scriptOptions.withArguments("--script", "path

ScriptOptions

Using AI Code Generation

1ScriptOptions scriptOptions = new ScriptOptions();2scriptOptions.withArguments("--script", "path_to_script");3driver.executeScript("mobile: executeDriverScript", scriptOptions);4ScriptOptions scriptOptions = new ScriptOptions();5scriptOptions.withArguments("--script", "path_to_script");6driver.executeScript("mobile: executeDriverScript", scriptOptions);7let scriptOptions = new ScriptOptions();8scriptOptions.withArguments('--script', 'path_to_script');9await driver.executeScript('mobile: executeDriverScript', scriptOptions);10let scriptOptions = new ScriptOptions();11scriptOptions.withArguments('--script', 'path_to_script');12await driver.executeScript('mobile: executeDriverScript', scriptOptions);13script_options = ScriptOptions()14script_options.withArguments('--script', 'path_to_script')15driver.execute_script('mobile: executeDriverScript', script_options)16script_options = ScriptOptions()17script_options.withArguments('--script', 'path_to_script')18driver.execute_script('mobile: executeDriverScript', script_options)19script_options.withArguments('--script', 'path_to_script')20driver.execute_script('mobile: executeDriverScript', script_options)21script_options.withArguments('--script', 'path_to_script')22driver.execute_script('mobile: executeDriverScript', script_options)23ScriptOptions scriptOptions = new ScriptOptions();24scriptOptions.WithArguments("--script", "path_to_script");25driver.ExecuteScript("mobile: executeDriverScript", scriptOptions);26ScriptOptions scriptOptions = new ScriptOptions();27scriptOptions.WithArguments("--script", "path_to_script

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.