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, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#closeObject

Disconnects from the device.



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

def close
  wrap_impl(@impl.close)
end

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

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

Raises:

  • (NotImplementedError)


16
17
18
# File 'lib/playwright_api/android_device.rb', line 16

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)


21
22
23
# File 'lib/playwright_api/android_device.rb', line 21

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)


26
27
28
# File 'lib/playwright_api/android_device.rb', line 26

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`.



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

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

#inputObject

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)


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

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

#launch_browser(acceptDownloads: nil, bypassCSP: nil, colorScheme: nil, command: nil, deviceScaleFactor: nil, extraHTTPHeaders: nil, geolocation: nil, hasTouch: nil, httpCredentials: nil, ignoreHTTPSErrors: nil, isMobile: nil, javaScriptEnabled: nil, locale: nil, noViewport: nil, offline: nil, permissions: nil, record_har_omit_content: nil, record_har_path: nil, record_video_dir: nil, record_video_size: nil, timezoneId: nil, userAgent: nil, viewport: nil, &block) ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/playwright_api/android_device.rb', line 41

def launch_browser(
      acceptDownloads: nil,
      bypassCSP: nil,
      colorScheme: nil,
      command: nil,
      deviceScaleFactor: nil,
      extraHTTPHeaders: nil,
      geolocation: nil,
      hasTouch: nil,
      httpCredentials: nil,
      ignoreHTTPSErrors: nil,
      isMobile: nil,
      javaScriptEnabled: nil,
      locale: nil,
      noViewport: nil,
      offline: nil,
      permissions: nil,
      record_har_omit_content: nil,
      record_har_path: nil,
      record_video_dir: nil,
      record_video_size: nil,
      timezoneId: nil,
      userAgent: nil,
      viewport: nil,
      &block)
  wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), 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), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), 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)


70
71
72
# File 'lib/playwright_api/android_device.rb', line 70

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

#modelObject

Device model.



75
76
77
# File 'lib/playwright_api/android_device.rb', line 75

def model
  wrap_impl(@impl.model)
end

#off(event, callback) ⇒ Object

– inherited from EventEmitter –



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

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

#on(event, callback) ⇒ Object

– inherited from EventEmitter –



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

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

#once(event, callback) ⇒ Object

– inherited from EventEmitter –



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

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)


80
81
82
# File 'lib/playwright_api/android_device.rb', line 80

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)


85
86
87
# File 'lib/playwright_api/android_device.rb', line 85

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)


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

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)


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

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)


100
101
102
# File 'lib/playwright_api/android_device.rb', line 100

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.



105
106
107
# File 'lib/playwright_api/android_device.rb', line 105

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)


110
111
112
# File 'lib/playwright_api/android_device.rb', line 110

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

#serialObject

Device serial number.



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

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)


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

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.



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

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

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

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

Raises:

  • (NotImplementedError)


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

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

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



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

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)


136
137
138
# File 'lib/playwright_api/android_device.rb', line 136

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

#treeObject



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

def tree
  wrap_impl(@impl.tree)
end

#wait(selector, state: nil) ⇒ Object

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

Raises:

  • (NotImplementedError)


141
142
143
# File 'lib/playwright_api/android_device.rb', line 141

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)


147
148
149
# File 'lib/playwright_api/android_device.rb', line 147

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)


153
154
155
# File 'lib/playwright_api/android_device.rb', line 153

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

#web_viewsObject

Currently open WebViews.

Raises:

  • (NotImplementedError)


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

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