Class: Playwright::AndroidDevice

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/android_device.rb

Overview

‘AndroidDevice` represents a connected device, either real hardware or emulated. Devices can be obtained using [`method: Android.devices`].

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#initialize, unwrap, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#close ⇒ Object

Disconnects from the device.



12
13
14
 
# File 'lib/playwright_api/android_device.rb', line 12

def close
  wrap_impl(@impl.close)
end

#drag(selector, dest, speed: nil) ⇒ Object

Drags the widget defined by ‘selector` towards `dest` point.

Raises:

  • (NotImplementedError) 


18
19
20
 
# File 'lib/playwright_api/android_device.rb', line 18

def drag(selector, dest, speed: nil)
  raise NotImplementedError.new('drag is not implemented yet.')
end

#fill(selector, text) ⇒ Object

Fills the specific ‘selector` input box with `text`.

Raises:

  • (NotImplementedError) 


24
25
26
 
# File 'lib/playwright_api/android_device.rb', line 24

def fill(selector, text)
  raise NotImplementedError.new('fill is not implemented yet.')
end

#fling(selector, direction, speed: nil) ⇒ Object

Flings the widget defined by ‘selector` in the specified `direction`.

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/playwright_api/android_device.rb', line 30

def fling(selector, direction, speed: nil)
  raise NotImplementedError.new('fling is not implemented yet.')
end

#info(selector) ⇒ Object

Returns information about a widget defined by ‘selector`.



36
37
38
 
# File 'lib/playwright_api/android_device.rb', line 36

def info(selector)
  wrap_impl(@impl.info(unwrap_impl(selector)))
end

#input ⇒ Object

property



6
7
8
 
# File 'lib/playwright_api/android_device.rb', line 6

def input # property
  wrap_impl(@impl.input)
end

#install_apk(file, args: nil) ⇒ Object

Installs an apk on the device.

Raises:

  • (NotImplementedError) 


42
43
44
 
# File 'lib/playwright_api/android_device.rb', line 42

def install_apk(file, args: nil)
  raise NotImplementedError.new('install_apk is not implemented yet.')
end

#launch_browser(acceptDownloads: nil, args: nil, baseURL: nil, bypassCSP: nil, colorScheme: nil, contrast: nil, deviceScaleFactor: nil, extraHTTPHeaders: nil, forcedColors: nil, geolocation: nil, hasTouch: nil, httpCredentials: nil, ignoreHTTPSErrors: nil, isMobile: nil, javaScriptEnabled: nil, locale: nil, noViewport: nil, offline: nil, permissions: nil, pkg: nil, proxy: nil, record_har_content: nil, record_har_mode: nil, record_har_omit_content: nil, record_har_path: nil, record_har_url_filter: nil, record_video_dir: nil, record_video_size: nil, reducedMotion: nil, screen: nil, serviceWorkers: nil, strictSelectors: nil, timezoneId: nil, userAgent: nil, viewport: nil, &block) ⇒ Object

Launches Chrome browser on the device, and returns its persistent context.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/playwright_api/android_device.rb', line 48

def launch_browser(
      acceptDownloads: nil,
      args: nil,
      baseURL: nil,
      bypassCSP: nil,
      colorScheme: nil,
      contrast: nil,
      deviceScaleFactor: nil,
      extraHTTPHeaders: nil,
      forcedColors: nil,
      geolocation: nil,
      hasTouch: nil,
      httpCredentials: nil,
      ignoreHTTPSErrors: nil,
      isMobile: nil,
      javaScriptEnabled: nil,
      locale: nil,
      noViewport: nil,
      offline: nil,
      permissions: nil,
      pkg: nil,
      proxy: nil,
      record_har_content: nil,
      record_har_mode: nil,
      record_har_omit_content: nil,
      record_har_path: nil,
      record_har_url_filter: nil,
      record_video_dir: nil,
      record_video_size: nil,
      reducedMotion: nil,
      screen: nil,
      serviceWorkers: nil,
      strictSelectors: nil,
      timezoneId: nil,
      userAgent: nil,
      viewport: nil,
      &block)
  wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), args: unwrap_impl(args), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), contrast: unwrap_impl(contrast), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), pkg: unwrap_impl(pkg), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
end

#long_tap(selector) ⇒ Object

Performs a long tap on the widget defined by ‘selector`.

Raises:

  • (NotImplementedError) 


90
91
92
 
# File 'lib/playwright_api/android_device.rb', line 90

def long_tap(selector)
  raise NotImplementedError.new('long_tap is not implemented yet.')
end

#model ⇒ Object

Device model.



96
97
98
 
# File 'lib/playwright_api/android_device.rb', line 96

def model
  wrap_impl(@impl.model)
end

#off(event, callback) ⇒ Object

– inherited from EventEmitter –



215
216
217
 
# File 'lib/playwright_api/android_device.rb', line 215

def off(event, callback)
  event_emitter_proxy.off(event, callback)
end

#on(event, callback) ⇒ Object

– inherited from EventEmitter –



209
210
211
 
# File 'lib/playwright_api/android_device.rb', line 209

def on(event, callback)
  event_emitter_proxy.on(event, callback)
end

#once(event, callback) ⇒ Object

– inherited from EventEmitter –



221
222
223
 
# File 'lib/playwright_api/android_device.rb', line 221

def once(event, callback)
  event_emitter_proxy.once(event, callback)
end

#open(command) ⇒ Object

Launches a process in the shell on the device and returns a socket to communicate with the launched process.

Raises:

  • (NotImplementedError) 


102
103
104
 
# File 'lib/playwright_api/android_device.rb', line 102

def open(command)
  raise NotImplementedError.new('open is not implemented yet.')
end

#pinch_close(selector, percent, speed: nil) ⇒ Object

Pinches the widget defined by ‘selector` in the closing direction.

Raises:

  • (NotImplementedError) 


108
109
110
 
# File 'lib/playwright_api/android_device.rb', line 108

def pinch_close(selector, percent, speed: nil)
  raise NotImplementedError.new('pinch_close is not implemented yet.')
end

#pinch_open(selector, percent, speed: nil) ⇒ Object

Pinches the widget defined by ‘selector` in the open direction.

Raises:

  • (NotImplementedError) 


114
115
116
 
# File 'lib/playwright_api/android_device.rb', line 114

def pinch_open(selector, percent, speed: nil)
  raise NotImplementedError.new('pinch_open is not implemented yet.')
end

#press(selector, key) ⇒ Object

Presses the specific ‘key` in the widget defined by `selector`.

Raises:

  • (NotImplementedError) 


120
121
122
 
# File 'lib/playwright_api/android_device.rb', line 120

def press(selector, key)
  raise NotImplementedError.new('press is not implemented yet.')
end

#push(file, path, mode: nil) ⇒ Object

Copies a file to the device.

Raises:

  • (NotImplementedError) 


126
127
128
 
# File 'lib/playwright_api/android_device.rb', line 126

def push(file, path, mode: nil)
  raise NotImplementedError.new('push is not implemented yet.')
end

#screenshot(path: nil) ⇒ Object

Returns the buffer with the captured screenshot of the device.



132
133
134
 
# File 'lib/playwright_api/android_device.rb', line 132

def screenshot(path: nil)
  wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
end

#scroll(selector, direction, percent, speed: nil) ⇒ Object

Scrolls the widget defined by ‘selector` in the specified `direction`.

Raises:

  • (NotImplementedError) 


138
139
140
 
# File 'lib/playwright_api/android_device.rb', line 138

def scroll(selector, direction, percent, speed: nil)
  raise NotImplementedError.new('scroll is not implemented yet.')
end

#serial ⇒ Object

Device serial number.



144
145
146
 
# File 'lib/playwright_api/android_device.rb', line 144

def serial
  wrap_impl(@impl.serial)
end

#set_default_timeout(timeout) ⇒ Object Also known as: default_timeout=

This setting will change the default maximum time for all the methods accepting ‘timeout` option.

Raises:

  • (NotImplementedError) 


150
151
152
 
# File 'lib/playwright_api/android_device.rb', line 150

def set_default_timeout(timeout)
  raise NotImplementedError.new('set_default_timeout is not implemented yet.')
end

#shell(command) ⇒ Object

Executes a shell command on the device and returns its output.



157
158
159
 
# File 'lib/playwright_api/android_device.rb', line 157

def shell(command)
  wrap_impl(@impl.shell(unwrap_impl(command)))
end

#should_close_connection_on_close! ⇒ Object 



198
199
200
 
# File 'lib/playwright_api/android_device.rb', line 198

def should_close_connection_on_close!
  wrap_impl(@impl.should_close_connection_on_close!)
end

#swipe(selector, direction, percent, speed: nil) ⇒ Object

Swipes the widget defined by ‘selector` in the specified `direction`.

Raises:

  • (NotImplementedError) 


163
164
165
 
# File 'lib/playwright_api/android_device.rb', line 163

def swipe(selector, direction, percent, speed: nil)
  raise NotImplementedError.new('swipe is not implemented yet.')
end

#tap_on(selector, duration: nil, timeout: nil) ⇒ Object 



203
204
205
 
# File 'lib/playwright_api/android_device.rb', line 203

def tap_on(selector, duration: nil, timeout: nil)
  wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
end

#tap_point(selector, duration: nil) ⇒ Object

Taps on the widget defined by ‘selector`.

Raises:

  • (NotImplementedError) 


169
170
171
 
# File 'lib/playwright_api/android_device.rb', line 169

def tap_point(selector, duration: nil)
  raise NotImplementedError.new('tap_point is not implemented yet.')
end

#wait(selector, state: nil) ⇒ Object

Waits for the specific ‘selector` to either appear or disappear, depending on the `state`.

Raises:

  • (NotImplementedError) 


175
176
177
 
# File 'lib/playwright_api/android_device.rb', line 175

def wait(selector, state: nil)
  raise NotImplementedError.new('wait is not implemented yet.')
end

#wait_for_event(event, optionsOrPredicate: nil) ⇒ Object

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value.

Raises:

  • (NotImplementedError) 


181
182
183
 
# File 'lib/playwright_api/android_device.rb', line 181

def wait_for_event(event, optionsOrPredicate: nil)
  raise NotImplementedError.new('wait_for_event is not implemented yet.')
end

#web_view(selector) ⇒ Object

This method waits until ‘AndroidWebView` matching the `selector` is opened and returns it. If there is already an open `AndroidWebView` matching the `selector`, returns immediately.

Raises:

  • (NotImplementedError) 


187
188
189
 
# File 'lib/playwright_api/android_device.rb', line 187

def web_view(selector)
  raise NotImplementedError.new('web_view is not implemented yet.')
end

#web_views ⇒ Object

Currently open WebViews.

Raises:

  • (NotImplementedError) 


193
194
195
 
# File 'lib/playwright_api/android_device.rb', line 193

def web_views
  raise NotImplementedError.new('web_views is not implemented yet.')
end