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/network.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, Network, Performance, Screen

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(_mod) ⇒ Object



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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/appium_lib_core/android/device.rb', line 269

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

  ::Appium::Core::Device.add_endpoint_method(:open_notifications) do
    def open_notifications
      execute :open_notifications
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:current_activity) do
    def current_activity
      execute :current_activity
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:current_package) do
    def current_package
      execute :current_package
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:get_system_bars) do
    def get_system_bars
      execute :get_system_bars
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:toggle_location_services) do
    def toggle_location_services
      execute :toggle_location_services
    end
  end

  ::Appium::Core::Device.add_endpoint_method(:start_activity) do
    def start_activity(opts)
      raise 'opts must be a hash' unless opts.is_a? Hash

      option = {}

      app_package = opts[:app_package]
      raise 'app_package is required' unless app_package

      app_activity = opts[:app_activity]
      raise 'app_activity is required' unless app_activity

      option[:appPackage] = app_package
      option[:appActivity] = app_activity

      app_wait_package  = opts.fetch(:app_wait_package, nil)
      app_wait_activity = opts.fetch(:app_wait_activity, nil)
      option[:appWaitPackage] = app_wait_package if app_wait_package
      option[:appWaitActivity] = app_wait_activity if app_wait_activity

      unknown_opts = opts.keys - %i(app_package app_activity app_wait_package app_wait_activity)
      raise "Unknown options #{unknown_opts}" unless unknown_opts.empty?

      execute :start_activity, {}, option
    end
  end

  # Android, Override included method in bridge
  ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
    def hide_keyboard(close_key = nil, strategy = nil)
      option = {}

      option[:key] = close_key if close_key
      option[:strategy] = strategy if strategy

      execute :hide_keyboard, {}, option
    end
  end

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

  # TODO: TEST ME
  ::Appium::Core::Device.add_endpoint_method(:end_coverage) do
    def end_coverage(path, intent)
      execute :end_coverage, {}, path: path, intent: intent
    end
  end

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

Instance Method Details

#current_activityString

Get current activity name

Examples:


@driver.current_activity # '.ApiDemos'

Returns:

  • (String)

    An activity name



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

#current_packageString

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 33

#end_coverage(path, intent) ⇒ Object

Android only; Ends the test coverage and writes the results to the given path on device.

Parameters:

  • path (String)

    Path on the device to write too.

  • intent (String)

    Intent to broadcast when ending coverage.



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

#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 252

#get_clipboard(content_type: :plaintext) ⇒ Object

Set the content of device's clipboard.



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

#get_display_densityInteger

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 51

#get_network_connectionObject

Get the device network connection current status See set_network_connection method for return value Same as #network_connection_type in selenium-webdriver.

Returns a key of {:airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0} in #network_connection_type Returns a number of the mode in `#get_network_connection`



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

#get_performance_data(package_name: , data_type: , data_read_timeout: 1000) ⇒ Object



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

#get_performance_data_typesObject

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 170

#get_system_barsString

Get system bar's information

Examples:


@driver.get_system_bars

Returns:

  • (String)


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

#hide_keyboard(close_key = nil, strategy = 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
@driver.hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard

Parameters:

  • close_key (String) (defaults to: nil)

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

  • strategy (Symbol) (defaults to: nil)

    The symbol of the strategy which closes the keyboard. XCUITest ignore this argument. Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.



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

#open_notificationsObject

Open Android notifications



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

#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 241

#set_network_connection(mode) ⇒ Object

Set the device network connection mode Same as `#network_connection_type` in selenium-webdriver.

Or the key matched with {:airplane_mode: 1, wifi: 2, data: 4, all: 6, none: 0}

Value (Alias)      | Data | Wifi | Airplane Mode
-------------------------------------------------
1 (Airplane Mode)  | 0    | 0    | 1
6 (All network on) | 1    | 1    | 0
4 (Data only)      | 1    | 0    | 0
2 (Wifi only)      | 0    | 1    | 0
0 (None)           | 0    | 0    | 0

Examples:


@driver.set_network_connection 1
@driver.set_network_connection :airplane_mode
@driver.network_connection_type = :airplane_mode # As selenium-webdriver

Parameters:

  • mode (String)

    Bit mask that represent the network mode



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

#start_activity(opts) ⇒ Object

Android only. Start a new activity within the current app or launch a new app and start the target activity.

Examples:


start_activity app_package: 'io.appium.android.apis',
  app_activity: '.accessibility.AccessibilityNodeProviderActivity'

Parameters:

  • opts (Hash)

    Options

Options Hash (opts):

  • :app_package (String)

    The package owning the activity [required]

  • :app_activity (String)

    The target activity [required]

  • :app_wait_package (String)

    The package to start before the target package [optional]

  • :app_wait_activity (String)

    The activity to start before the target activity [optional]



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

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

Examples:


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

Parameters:

  • remote_path (String)

    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)

    The name of the user for the remote authentication.

  • pass (String)

    The password for the remote authentication.

  • method (String)

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

  • force_restart (Boolean)

    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)

    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)

    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)

    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)

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



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

#toggle_airplane_modeObject

Toggle flight mode on or off

Examples:


@driver.toggle_airplane_mode


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

#toggle_dataObject

Switch the state of data service only for Android, and the device should be rooted



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

#toggle_location_servicesObject

Switch the state of the location service



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

#toggle_wifiObject

Switch the state of the wifi service only for Android



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