AndroidDevice
AndroidDevice represents a connected device, either real hardware or emulated. Devices can be obtained using android.devices().
Methods
close
Added in: v1.9Disconnects from the device.
Usage
await androidDevice.close();
Returns
drag
Added in: v1.9Drags the widget defined by selector
towards dest
point.
Usage
await androidDevice.drag(selector, dest);
await androidDevice.drag(selector, dest, options);
Arguments
-
selector
[AndroidSelector]#Selector to drag.
-
Point to drag to.
-
options
Object (optional)-
Optional speed of the drag in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
fill
Added in: v1.9Fills the specific selector
input box with text
.
Usage
await androidDevice.fill(selector, text);
await androidDevice.fill(selector, text, options);
Arguments
-
selector
[AndroidSelector]#Selector to fill.
-
Text to be filled in the input box.
-
options
Object (optional)-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
fling
Added in: v1.9Flings the widget defined by selector
in the specified direction
.
Usage
await androidDevice.fling(selector, direction);
await androidDevice.fling(selector, direction, options);
Arguments
-
selector
[AndroidSelector]#Selector to fling.
-
direction
"down" | "up" | "left" | "right"#Fling direction.
-
options
Object (optional)-
Optional speed of the fling in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
info
Added in: v1.9Returns information about a widget defined by selector
.
Usage
await androidDevice.info(selector);
Arguments
-
selector
[AndroidSelector]#Selector to return information about.
Returns
installApk
Added in: v1.9Installs an apk on the device.
Usage
await androidDevice.installApk(file);
await androidDevice.installApk(file, options);
Arguments
-
Either a path to the apk file, or apk file content.
-
options
Object (optional)
Returns
launchBrowser
Added in: v1.9Launches Chrome browser on the device, and returns its persistent context.
Usage
await androidDevice.launchBrowser();
await androidDevice.launchBrowser(options);
Arguments
options
Object (optional)-
acceptDownloads
boolean (optional)#Whether to automatically download all the attachments. Defaults to
true
where all the downloads are accepted. -
args
Array<string> (optional) Added in: v1.29#warningUse custom browser args at your own risk, as some of them may break Playwright functionality.
Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
-
When using page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), or page.waitForResponse() it takes the base URL in consideration by using the
URL()
constructor for building the corresponding URL. Unset by default. Examples:- baseURL:
http://localhost:3000
and navigating to/bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
http://localhost:3000/foo/
and navigating to./bar.html
results inhttp://localhost:3000/foo/bar.html
- baseURL:
http://localhost:3000/foo
(without trailing slash) and navigating to./bar.html
results inhttp://localhost:3000/bar.html
- baseURL:
-
Toggles bypassing page's Content-Security-Policy. Defaults to
false
. -
colorScheme
null | "light" | "dark" | "no-preference" (optional)#Emulates
'prefers-colors-scheme'
media feature, supported values are'light'
,'dark'
,'no-preference'
. See page.emulateMedia() for more details. Passingnull
resets emulation to system defaults. Defaults to'light'
. -
Optional package name to launch instead of default Chrome for Android.
-
deviceScaleFactor
number (optional)#Specify device scale factor (can be thought of as dpr). Defaults to
1
. Learn more about emulating devices with device scale factor. -
extraHTTPHeaders
Object<string, string> (optional)#An object containing additional HTTP headers to be sent with every request. Defaults to none.
-
forcedColors
null | "active" | "none" (optional)#Emulates
'forced-colors'
media feature, supported values are'active'
,'none'
. See page.emulateMedia() for more details. Passingnull
resets emulation to system defaults. Defaults to'none'
. -
Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
-
httpCredentials
Object (optional)#-
username
string -
password
string -
origin
string (optional)Restrain sending http credentials on specific origin (scheme://host:port).
-
send
"unauthorized" | "always" (optional)This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser.
'always'
-Authorization
header with basic authentication credentials will be sent with the each API request.'unauthorized
- the credentials are only sent when 401 (Unauthorized) response withWWW-Authenticate
header is received. Defaults to'unauthorized'
.
Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
-
-
ignoreHTTPSErrors
boolean (optional)#Whether to ignore HTTPS errors when sending network requests. Defaults to
false
. -
Whether the
meta viewport
tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults tofalse
and is not supported in Firefox. Learn more about mobile emulation. -
javaScriptEnabled
boolean (optional)#Whether or not to enable JavaScript in the context. Defaults to
true
. Learn more about disabling JavaScript. -
Specify user locale, for example
en-GB
,de-DE
, etc. Locale will affectnavigator.language
value,Accept-Language
request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide. -
Logger sink for Playwright logging.
-
Whether to emulate network being offline. Defaults to
false
. Learn more about network emulation. -
permissions
Array<string> (optional)#A list of permissions to grant to all pages in this context. See browserContext.grantPermissions() for more details. Defaults to none.
-
proxy
Object (optional) Added in: v1.29#-
server
stringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128
orsocks5://myproxy.com:3128
. Short formmyproxy.com:3128
is considered an HTTP proxy. -
bypass
string (optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com"
. -
username
string (optional)Optional username to use if HTTP proxy requires authentication.
-
password
string (optional)Optional password to use if HTTP proxy requires authentication.
Network proxy settings.
-
-
-
omitContent
boolean (optional)Optional setting to control whether to omit request content from the HAR. Defaults to
false
. Deprecated, usecontent
policy instead. -
content
"omit" | "embed" | "attach" (optional)Optional setting to control resource content management. If
omit
is specified, content is not persisted. Ifattach
is specified, resources are persisted as separate files or entries in the ZIP archive. Ifembed
is specified, content is stored inline the HAR file as per HAR specification. Defaults toattach
for.zip
output files and toembed
for all other file extensions. -
path
stringPath on the filesystem to write the HAR file to. If the file name ends with
.zip
,content: 'attach'
is used by default. -
mode
"full" | "minimal" (optional)When set to
minimal
, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults tofull
. -
urlFilter
string | RegExp (optional)A glob or regex pattern to filter requests that are stored in the HAR. When a
baseURL
via the context options was provided and the passed URL is a path, it gets merged via thenew URL()
constructor. Defaults to none.
Enables HAR recording for all pages into
recordHar.path
file. If not specified, the HAR is not recorded. Make sure to await browserContext.close() for the HAR to be saved. -
-
recordVideo
Object (optional)#-
dir
stringPath to the directory to put videos into.
-
size
Object (optional)Optional dimensions of the recorded videos. If not specified the size will be equal to
viewport
scaled down to fit into 800x800. Ifviewport
is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
Enables video recording for all pages into
recordVideo.dir
directory. If not specified videos are not recorded. Make sure to await browserContext.close() for videos to be saved. -
-
reducedMotion
null | "reduce" | "no-preference" (optional)#Emulates
'prefers-reduced-motion'
media feature, supported values are'reduce'
,'no-preference'
. See page.emulateMedia() for more details. Passingnull
resets emulation to system defaults. Defaults to'no-preference'
. -
Emulates consistent window screen size available inside web page via
window.screen
. Is only used when theviewport
is set. -
serviceWorkers
"allow" | "block" (optional)#Whether to allow sites to register Service workers. Defaults to
'allow'
.'allow'
: Service Workers can be registered.'block'
: Playwright will block all registration of Service Workers.
-
strictSelectors
boolean (optional)#If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to
false
. See Locator to learn more about the strict mode. -
Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
-
Specific user agent to use in this context.
-
Deprecated
Use
recordVideo
instead. -
Deprecated
Use
recordVideo
instead. -
viewport
null | Object (optional)#Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use
null
to disable the consistent viewport emulation. Learn more about viewport emulation.noteThe
null
value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.
-
Returns
longTap
Added in: v1.9Performs a long tap on the widget defined by selector
.
Usage
await androidDevice.longTap(selector);
await androidDevice.longTap(selector, options);
Arguments
-
selector
[AndroidSelector]#Selector to tap on.
-
options
Object (optional)-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
model
Added in: v1.9Device model.
Usage
androidDevice.model();
Returns
open
Added in: v1.9Launches a process in the shell on the device and returns a socket to communicate with the launched process.
Usage
await androidDevice.open(command);
Arguments
Returns
pinchClose
Added in: v1.9Pinches the widget defined by selector
in the closing direction.
Usage
await androidDevice.pinchClose(selector, percent);
await androidDevice.pinchClose(selector, percent, options);
Arguments
-
selector
[AndroidSelector]#Selector to pinch close.
-
The size of the pinch as a percentage of the widget's size.
-
options
Object (optional)-
Optional speed of the pinch in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
pinchOpen
Added in: v1.9Pinches the widget defined by selector
in the open direction.
Usage
await androidDevice.pinchOpen(selector, percent);
await androidDevice.pinchOpen(selector, percent, options);
Arguments
-
selector
[AndroidSelector]#Selector to pinch open.
-
The size of the pinch as a percentage of the widget's size.
-
options
Object (optional)-
Optional speed of the pinch in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
press
Added in: v1.9Presses the specific key
in the widget defined by selector
.
Usage
await androidDevice.press(selector, key);
await androidDevice.press(selector, key, options);
Arguments
-
selector
[AndroidSelector]#Selector to press the key in.
-
key
[AndroidKey]#The key to press.
-
options
Object (optional)-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
push
Added in: v1.9Copies a file to the device.
Usage
await androidDevice.push(file, path);
await androidDevice.push(file, path, options);
Arguments
-
Either a path to the file, or file content.
-
Path to the file on the device.
-
options
Object (optional)
Returns
screenshot
Added in: v1.9Returns the buffer with the captured screenshot of the device.
Usage
await androidDevice.screenshot();
await androidDevice.screenshot(options);
Arguments
options
Object (optional)
Returns
scroll
Added in: v1.9Scrolls the widget defined by selector
in the specified direction
.
Usage
await androidDevice.scroll(selector, direction, percent);
await androidDevice.scroll(selector, direction, percent, options);
Arguments
-
selector
[AndroidSelector]#Selector to scroll.
-
direction
"down" | "up" | "left" | "right"#Scroll direction.
-
Distance to scroll as a percentage of the widget's size.
-
options
Object (optional)-
Optional speed of the scroll in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
serial
Added in: v1.9Device serial number.
Usage
androidDevice.serial();
Returns
setDefaultTimeout
Added in: v1.9This setting will change the default maximum time for all the methods accepting timeout
option.
Usage
androidDevice.setDefaultTimeout(timeout);
Arguments
shell
Added in: v1.9Executes a shell command on the device and returns its output.
Usage
await androidDevice.shell(command);
Arguments
Returns
swipe
Added in: v1.9Swipes the widget defined by selector
in the specified direction
.
Usage
await androidDevice.swipe(selector, direction, percent);
await androidDevice.swipe(selector, direction, percent, options);
Arguments
-
selector
[AndroidSelector]#Selector to swipe.
-
direction
"down" | "up" | "left" | "right"#Swipe direction.
-
Distance to swipe as a percentage of the widget's size.
-
options
Object (optional)-
Optional speed of the swipe in pixels per second.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
tap
Added in: v1.9Taps on the widget defined by selector
.
Usage
await androidDevice.tap(selector);
await androidDevice.tap(selector, options);
Arguments
-
selector
[AndroidSelector]#Selector to tap on.
-
options
Object (optional)-
Optional duration of the tap in milliseconds.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
wait
Added in: v1.9Waits for the specific selector
to either appear or disappear, depending on the state
.
Usage
await androidDevice.wait(selector);
await androidDevice.wait(selector, options);
Arguments
-
selector
[AndroidSelector]#Selector to wait for.
-
options
Object (optional)-
state
"gone" (optional)#Optional state. Can be either:
- default - wait for element to be present.
'gone'
- wait for element to not be present.
-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
waitForEvent
Added in: v1.9Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value.
Usage
await androidDevice.waitForEvent(event);
await androidDevice.waitForEvent(event, optionsOrPredicate);
Arguments
-
Event name, same one typically passed into
*.on(event)
. -
optionsOrPredicate
function | Object (optional)#-
predicate
functionreceives the event data and resolves to truthy value when the waiting should resolve.
-
timeout
number (optional)maximum time to wait for in milliseconds. Defaults to
30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout().
Either a predicate that receives an event or an options object. Optional.
-
Returns
webView
Added in: v1.9This method waits until AndroidWebView matching the selector
is opened and returns it. If there is already an open AndroidWebView matching the selector
, returns immediately.
Usage
await androidDevice.webView(selector);
await androidDevice.webView(selector, options);
Arguments
selector
Object#options
Object (optional)-
Maximum time in milliseconds, defaults to 30 seconds, pass
0
to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.
-
Returns
webViews
Added in: v1.9Currently open WebViews.
Usage
androidDevice.webViews();
Returns
Properties
input
Added in: v1.9Usage
androidDevice.input
Type
Events
on('close')
Added in: v1.28Emitted when the device connection gets closed.
Usage
androidDevice.on('close', data => {});
Event data
on('webview')
Added in: v1.9Emitted when a new WebView instance is detected.
Usage
androidDevice.on('webview', data => {});
Event data