timeouts

hogwarts · 2020 年8 月 10 日 06:24

Set Timeouts

Configure the amount of time that a particular type of operation can execute for before they are aborted
//: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/session/timeouts/timeouts.yml)

Example Usage

// Java
driver.manage().timeouts().pageLoadTimeout(30, TimeUnit.SECONDS);

# Python
self.driver.set_page_load_timeout(5000)

// Javascript
// webdriver.io example
driver.setTimeouts(5000)

// wd example
await driver.setPageLoadTimeout(5000);

# Ruby
# ruby_lib example
timeout('pageLoad', 5) # Ruby translates it to seconds

# ruby_lib_core example
@driver.timeout('pageLoad', 5) # Ruby translates it to seconds

# PHP
// TODO PHP sample

// C#
driver.Manage().Timeouts().PageLoad = TimeSpan.FromSeconds(30);

Description

The types of timeouts are ‘page load’, ‘script’ and ‘implicit’. (The example usage is just ‘page load’)

Support

Appium Server

Platform	Driver	Platform Versions	Appium Version	Driver Version
iOS	XCUITest	9.3+	1.6.0+	All
	UIAutomation	8.0 to 9.3	All	All
Android	Espresso	?+	1.9.0+	All
	UiAutomator2	?+	1.6.0+	All
	UiAutomator	4.3+	All	All
Mac	Mac	?+	1.6.4+	All
Windows	Windows	10+	1.6.0+	All

Appium Clients

Language	Support	Documentation
Java	All	seleniumhq.github.io
Python	All	selenium-python.readthedocs.io
Javascript (WebdriverIO)	All
Javascript (WD)	All	github.com
Ruby	All	www.rubydoc.info
PHP	All	github.com
C#	All	github.com

HTTP API Specifications

Endpoint

POST /session/:session_id/timeouts

URL Parameters

name	description
session_id	ID of the session to route the command to

JSON Parameters

name	type	description
type	`string`	The type of operation to set the timeout for. Valid values are: ‘script’ for script timeouts, ‘implicit’ for modifying the implicit wait timeout and ‘page load’ for setting a page load timeout.
ms	`number`	The amount of time, in milliseconds, that time-limited commands are permitted to run

Response

null