Module: Appium::Core::Android::Device

Extended by:
Forwardable
Defined in:
lib/appium_lib_core/android/device.rb,
lib/appium_lib_core/android/device/screen.rb,
lib/appium_lib_core/android/device/emulator.rb,
lib/appium_lib_core/android/device/clipboard.rb,
lib/appium_lib_core/android/device/performance.rb,
lib/appium_lib_core/android/device/auth_finger_print.rb

Defined Under Namespace

Modules: Authentication, Clipboard, Emulator, Performance, Screen

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(_mod) ⇒ Object 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/appium_lib_core/android/device.rb', line 250

def extended(_mod)
  ::Appium::Core::Device.extend_webdriver_with_forwardable

  ::Appium::Core::Device.add_endpoint_method(:open_notifications) do
    def open_notifications
      execute_script 'mobile:openNotifications', {}
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:current_activity) do
    def current_activity
      execute_script 'mobile:getCurrentActivity', {}
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:current_package) do
    def current_package
      execute_script 'mobile:getCurrentPackage', {}
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:get_system_bars) do
    def get_system_bars
      execute_script 'mobile:getSystemBars', {}
    end
  end
  # as alias to get_system_bars
  ::Appium::Core::Device.add_endpoint_method(:system_bars) do
    def system_bars
      execute_script 'mobile:getSystemBars', {}
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:toggle_location_services) do
    def toggle_location_services
      execute_script 'mobile:toggleGps', {}
    end
  end

  # Android, Override included method in bridge
  ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
    def hide_keyboard(_close_key = nil)
      execute_script 'mobile:hideKeyboard', {}
    end
  end

  # Android, Override included method in bridge
  ::Appium::Core::Device.add_endpoint_method(:background_app) do
    def background_app(duration = 0)
      execute_script 'mobile:backgroundApp', { seconds: duration }
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:execute_cdp) do
    # SeleniumWebdriver could already define this method
    return if method_defined? :execute_cdp

    def execute_cdp(cmd, **params)
      execute :chrome_send_command, {}, { cmd: cmd, params: params }
    end
  end

  Screen.add_methods
  Performance.add_methods
  Clipboard.add_methods
  Emulator.add_methods
  Authentication.add_methods
end

Instance Method Details

#current_activity ⇒ String

Get current activity name

Examples:


@driver.current_activity # '.ApiDemos'

Returns:

  • (String) —

    An activity name



# File 'lib/appium_lib_core/android/device.rb', line 37

#current_package ⇒ String

Get current package name

Examples:


@driver.current_package # 'com.example.android.apis'

Returns:

  • (String) —

    A package name



# File 'lib/appium_lib_core/android/device.rb', line 46

#execute_cdp(cmd, **params) ⇒ Object

Execute Chrome Devtools protocol commands chromedevtools.github.io/devtools-protocol



# File 'lib/appium_lib_core/android/device.rb', line 226

#finger_print(finger_id) ⇒ Object

Authenticate users by using their finger print scans on supported emulators.



# File 'lib/appium_lib_core/android/device.rb', line 216

#get_clipboard(content_type: :plaintext) ⇒ Object

Set the content of device’s clipboard.



# File 'lib/appium_lib_core/android/device.rb', line 195

#get_display_density ⇒ Integer

Get connected device’s density.

Examples:


@driver.get_display_density # 320

Returns:

  • (Integer) —

    The size of density



# File 'lib/appium_lib_core/android/device.rb', line 65

#get_performance_data(package_name: , data_type: ) ⇒ Object

Get the resource usage information of the application. github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L303



# File 'lib/appium_lib_core/android/device.rb', line 138

#get_performance_data_types ⇒ Object

Get the information type of the system state which is supported to read such as cpu, memory, network, battery via adb commands. github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L300



# File 'lib/appium_lib_core/android/device.rb', line 128

#get_system_bars ⇒ String

Get system bar’s information

Examples:


@driver.get_system_bars
@driver.system_bars

Returns:

  • (String) 


# File 'lib/appium_lib_core/android/device.rb', line 55

#hide_keyboard(close_key = nil) ⇒ Object

Hide the onscreen keyboard

Examples:


@driver.hide_keyboard                   # Close a keyboard with the 'Done' button
@driver.hide_keyboard('Finished')       # Close a keyboard with the 'Finished' button

Parameters:

  • close_key (String) (defaults to: nil) —

    The name of the key which closes the keyboard. Defaults to ‘Done’ for iOS(except for XCUITest).



# File 'lib/appium_lib_core/android/device.rb', line 117

#location ⇒ ::Appium::Location

Get the location of the device.

Set the [::Appium::Location] of the device.

Examples:


driver.location #=> ::Appium::Location.new(10, 10, 10)

driver.location = ::Appium::Location.new(10, 10, 10)

Returns:



# File 'lib/appium_lib_core/android/device.rb', line 74

#location= ⇒ ::Appium::Location

Get the location of the device.

Set the [::Appium::Location] of the device.

Examples:


driver.location #=> ::Appium::Location.new(10, 10, 10)

driver.location = ::Appium::Location.new(10, 10, 10)

Returns:



# File 'lib/appium_lib_core/android/device.rb', line 74

#open_notifications ⇒ Object

Open Android notifications



# File 'lib/appium_lib_core/android/device.rb', line 29

#set_clipboard(content: , content_type: :plaintext, label: nil) ⇒ Object

Set the content of device’s clipboard.



# File 'lib/appium_lib_core/android/device.rb', line 205

#set_location(latitude, longitude, altitude, speed: nil, satellites: nil) ⇒ Object

Set the location of the device.

Examples:


driver.set_location 10, 10, 0

Parameters:

  • latitude (String, Number) —

    Set the latitude.

  • longitude (String, Number) —

    Set the longitude.

  • altitude (String, Number) —

    Set the altitude.

  • speed (String, Number) (defaults to: nil) —

    Set the speed to apply the location on Android real devices in meters/second @since Appium 1.21.0 and in knots for emulators @since Appium 1.22.0.

  • satellites (String, Number) (defaults to: nil) —

    Sets the count of geo satellites being tracked in range 1..12 @since Appium 1.22.0. This number is respected on Emulators.



# File 'lib/appium_lib_core/android/device.rb', line 91

#start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, video_size: nil, time_limit: '180', bit_rate: '4000000', bug_report: nil) ⇒ String

Returns Base64 encoded content of the recorded media file or an empty string if the file has been successfully uploaded to a remote location (depends on the actual options).

Examples:


@driver.start_recording_screen
@driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000'

Parameters:

  • remote_path (String) (defaults to: nil) —

    The path to the remote location, where the resulting video should be uploaded. The following protocols are supported: http/https, ftp. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64 and passed as the endpoint response value. An exception will be thrown if the generated media file is too big to fit into the available process memory. This option only has an effect if there is screen recording process in progress and forceRestart parameter is not set to true.

  • user (String) (defaults to: nil) —

    The name of the user for the remote authentication.

  • pass (String) (defaults to: nil) —

    The password for the remote authentication.

  • method (String) (defaults to: 'PUT') —

    The http multipart upload method name. The ‘PUT’ one is used by default.

  • file_field_name (String) (defaults to: nil) —

    The name of the form field containing the binary payload in multipart/form-data requests since Appium 1.18.0. Defaults to ‘file’.

  • form_fields (Array<Hash, Array<String>>) (defaults to: nil) —

    The form fields mapping in multipart/form-data requests since Appium 1.18.0. If any entry has the same key in this mapping, then it is going to be ignored.

  • headers (Hash) (defaults to: nil) —

    The additional headers in multipart/form-data requests since Appium 1.18.0.

  • force_restart (Boolean) (defaults to: nil) —

    Whether to try to catch and upload/return the currently running screen recording (false, the default setting on server) or ignore the result of it and start a new recording immediately (true).

  • video_size (String) (defaults to: nil) —

    The format is widthxheight. The default value is the device’s native display resolution (if supported), 1280x720 if not. For best results, use a size supported by your device’s Advanced Video Coding (AVC) encoder. For example, “1280x720”

  • time_limit (String) (defaults to: '180') —

    Recording time. 180 seconds is by default. Since Appium 1.8.2 the time limit can be up to 1800 seconds (30 minutes). Appium will automatically try to merge the 3-minutes chunks recorded by the screenrecord utility, however, this requires FFMPEG utility to be installed and available in PATH on the server machine. If the utility is not present then the most recent screen recording chunk is going to be returned as the result.

  • bit_rate (String) (defaults to: '4000000') —

    The video bit rate for the video, in megabits per second. 4 Mbp/s(4000000) is by default for Android API level below 27. 20 Mb/s(20000000) for API level 27 and above.

  • bug_report (Boolean) (defaults to: nil) —

    Set it to true in order to display additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs. This option is only supported since API level 27 (Android P).

Returns:

  • (String) —

    Base64 encoded content of the recorded media file or an empty string if the file has been successfully uploaded to a remote location (depends on the actual options)



# File 'lib/appium_lib_core/android/device.rb', line 149

#toggle_location_services ⇒ Object

Switch the state of the location service



# File 'lib/appium_lib_core/android/device.rb', line 107