Module: Appium::Core::Commands

Defined in:

lib/appium_lib_core/common/command.rb

Overview

ref: github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js

Constant Summary

COMMAND =

Some commands differ for each driver.

{
  ###
  # W3C
  ###
  status: [:get, 'status'],

  #
  # session handling
  #

  new_session: [:post, 'session'],
  delete_session: [:delete, 'session/:session_id'],

  #
  # basic driver
  #

  get: [:post, 'session/:session_id/url'],
  get_current_url: [:get, 'session/:session_id/url'],
  back: [:post, 'session/:session_id/back'],
  forward: [:post, 'session/:session_id/forward'],
  refresh: [:post, 'session/:session_id/refresh'],
  get_title: [:get, 'session/:session_id/title'],

  #
  # window and Frame handling
  #

  get_window_handle: [:get, 'session/:session_id/window'],
  new_window: [:post, 'session/:session_id/window/new'],
  close_window: [:delete, 'session/:session_id/window'],
  switch_to_window: [:post, 'session/:session_id/window'],
  get_window_handles: [:get, 'session/:session_id/window/handles'],
  fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
  minimize_window: [:post, 'session/:session_id/window/minimize'],
  maximize_window: [:post, 'session/:session_id/window/maximize'],
  set_window_size: [:post, 'session/:session_id/window/size'],
  get_window_size: [:get, 'session/:session_id/window/size'],
  set_window_position: [:post, 'session/:session_id/window/position'],
  get_window_position: [:get, 'session/:session_id/window/position'],
  set_window_rect: [:post, 'session/:session_id/window/rect'],
  get_window_rect: [:get, 'session/:session_id/window/rect'],
  switch_to_frame: [:post, 'session/:session_id/frame'],
  switch_to_parent_frame: [:post, 'session/:session_id/frame/parent'],

  #
  # element
  #

  find_element: [:post, 'session/:session_id/element'],
  find_elements: [:post, 'session/:session_id/elements'],
  find_child_element: [:post, 'session/:session_id/element/:id/element'],
  find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
  find_shadow_child_element: [:post, 'session/:session_id/shadow/:id/element'],
  find_shadow_child_elements: [:post, 'session/:session_id/shadow/:id/elements'],
  get_active_element: [:get, 'session/:session_id/element/active'],
  is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
  get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
  get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
  get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
  get_element_aria_role: [:get, 'session/:session_id/element/:id/computedrole'],
  get_element_aria_label: [:get, 'session/:session_id/element/:id/computedlabel'],
  get_element_text: [:get, 'session/:session_id/element/:id/text'],
  get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
  get_element_rect: [:get, 'session/:session_id/element/:id/rect'],
  is_element_enabled: [:get, 'session/:session_id/element/:id/enabled'],

  #
  # document handling
  #

  get_page_source: [:get, 'session/:session_id/source'],
  execute_script: [:post, 'session/:session_id/execute/sync'],
  execute_async_script: [:post, 'session/:session_id/execute/async'],

  #
  # cookies
  #

  get_all_cookies: [:get, 'session/:session_id/cookie'],
  get_cookie: [:get, 'session/:session_id/cookie/:name'],
  add_cookie: [:post, 'session/:session_id/cookie'],
  delete_cookie: [:delete, 'session/:session_id/cookie/:name'],
  delete_all_cookies: [:delete, 'session/:session_id/cookie'],

  #
  # timeouts
  #

  set_timeout: [:post, 'session/:session_id/timeouts'],

  #
  # actions
  #

  actions: [:post, 'session/:session_id/actions'],
  release_actions: [:delete, 'session/:session_id/actions'],
  print_page: [:post, 'session/:session_id/print'],

  #
  # Element Operations
  #

  element_click: [:post, 'session/:session_id/element/:id/click'],
  element_tap: [:post, 'session/:session_id/element/:id/tap'],
  element_clear: [:post, 'session/:session_id/element/:id/clear'],
  element_send_keys: [:post, 'session/:session_id/element/:id/value'],

  #
  # alerts
  #

  dismiss_alert: [:post, 'session/:session_id/alert/dismiss'],
  accept_alert: [:post, 'session/:session_id/alert/accept'],
  get_alert_text: [:get, 'session/:session_id/alert/text'],
  send_alert_text: [:post, 'session/:session_id/alert/text'],

  #
  # screenshot
  #

  take_screenshot: [:get, 'session/:session_id/screenshot'],
  take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],

  #
  # server extensions
  #

  upload_file: [:post, 'session/:session_id/se/file'],

  ###
  # Used by Appium, but no in W3C
  ###

  # ::Appium::Core::Base::Commands::OSS has the following commands and Appium also use them.
  # Delegated to ::Appium::Core::Base::Commands::OSS commands
  is_element_displayed: [:get, 'session/:session_id/element/:id/displayed'], # hint: https://w3c.github.io/webdriver/#element-displayedness

  get_timeouts: [:get, 'session/:session_id/timeouts'], # https://w3c.github.io/webdriver/#get-timeouts

  # Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
  ### Session capability
  get_capabilities: [:get, 'session/:session_id'],

  ### rotatable
  get_screen_orientation: [:get, 'session/:session_id/orientation'],
  set_screen_orientation: [:post, 'session/:session_id/orientation'],

  get_location: [:get, 'session/:session_id/location'],
  set_location: [:post, 'session/:session_id/location'],

  ### For IME
  ime_get_available_engines: [:get, 'session/:session_id/ime/available_engines'],
  ime_get_active_engine: [:get, 'session/:session_id/ime/active_engine'],
  ime_is_activated: [:get, 'session/:session_id/ime/activated'],
  ime_deactivate: [:post, 'session/:session_id/ime/deactivate'],
  ime_activate_engine: [:post, 'session/:session_id/ime/activate'],

  ### Logs
  get_available_log_types: [:get, 'session/:session_id/log/types'],
  get_log: [:post, 'session/:session_id/log'],

  ###
  # Appium own
  ###

  # common
  get_all_sessions: [:get, 'sessions'],
  available_contexts: [:get, 'session/:session_id/contexts'],
  set_context: [:post, 'session/:session_id/context'],
  current_context: [:get, 'session/:session_id/context'],

  touch_actions: [:post, 'session/:session_id/touch/perform'],
  multi_touch: [:post, 'session/:session_id/touch/multi/perform'],

  set_immediate_value: [:post, 'session/:session_id/appium/element/:id/value'],
  replace_value: [:post, 'session/:session_id/appium/element/:id/replace_value'],

  launch_app: [:post, 'session/:session_id/appium/app/launch'],
  close_app: [:post, 'session/:session_id/appium/app/close'],
  reset: [:post, 'session/:session_id/appium/app/reset'],
  background_app: [:post, 'session/:session_id/appium/app/background'],
  app_strings: [:post, 'session/:session_id/appium/app/strings'],

  device_locked?: [:post, 'session/:session_id/appium/device/is_locked'],
  unlock: [:post, 'session/:session_id/appium/device/unlock'],
  lock: [:post, 'session/:session_id/appium/device/lock'],
  device_time: [:get, 'session/:session_id/appium/device/system_time'],
  install_app: [:post, 'session/:session_id/appium/device/install_app'],
  remove_app: [:post, 'session/:session_id/appium/device/remove_app'],
  app_installed?: [:post, 'session/:session_id/appium/device/app_installed'],
  activate_app: [:post, 'session/:session_id/appium/device/activate_app'],
  terminate_app: [:post, 'session/:session_id/appium/device/terminate_app'],
  app_state: [:post, 'session/:session_id/appium/device/app_state'],
  shake: [:post, 'session/:session_id/appium/device/shake'],
  hide_keyboard: [:post, 'session/:session_id/appium/device/hide_keyboard'],
  press_keycode: [:post, 'session/:session_id/appium/device/press_keycode'],
  long_press_keycode: [:post, 'session/:session_id/appium/device/long_press_keycode'],
  push_file: [:post, 'session/:session_id/appium/device/push_file'],
  pull_file: [:post, 'session/:session_id/appium/device/pull_file'],
  pull_folder: [:post, 'session/:session_id/appium/device/pull_folder'],
  get_clipboard: [:post, 'session/:session_id/appium/device/get_clipboard'],
  set_clipboard: [:post, 'session/:session_id/appium/device/set_clipboard'],
  finger_print: [:post, 'session/:session_id/appium/device/finger_print'],
  get_settings: [:get, 'session/:session_id/appium/settings'],
  update_settings: [:post, 'session/:session_id/appium/settings'],
  stop_recording_screen: [:post, 'session/:session_id/appium/stop_recording_screen'],
  start_recording_screen: [:post, 'session/:session_id/appium/start_recording_screen'],
  compare_images: [:post, 'session/:session_id/appium/compare_images'],
  is_keyboard_shown: [:get, 'session/:session_id/appium/device/is_keyboard_shown'],
  execute_driver: [:post, 'session/:session_id/appium/execute_driver'],
  post_log_event: [:post, 'session/:session_id/appium/log_event'],
  get_log_events: [:post, 'session/:session_id/appium/events']
}.freeze

COMMAND_ANDROID =

{
  open_notifications: [:post, 'session/:session_id/appium/device/open_notifications'],
  toggle_airplane_mode: [:post, 'session/:session_id/appium/device/toggle_airplane_mode'],
  start_activity: [:post, 'session/:session_id/appium/device/start_activity'],
  current_activity: [:get, 'session/:session_id/appium/device/current_activity'],
  current_package: [:get, 'session/:session_id/appium/device/current_package'],
  get_system_bars: [:get, 'session/:session_id/appium/device/system_bars'],
  get_display_density: [:get, 'session/:session_id/appium/device/display_density'],
  toggle_wifi: [:post, 'session/:session_id/appium/device/toggle_wifi'],
  toggle_data: [:post, 'session/:session_id/appium/device/toggle_data'],
  toggle_location_services: [:post, 'session/:session_id/appium/device/toggle_location_services'],
  end_coverage: [:post, 'session/:session_id/appium/app/end_test_coverage'],
  get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'],
  get_performance_data: [:post, 'session/:session_id/appium/getPerformanceData'],
  get_network_connection: [:get, 'session/:session_id/network_connection'], # defined also in OSS
  set_network_connection: [:post, 'session/:session_id/network_connection'], # defined also in OSS

  # only emulator
  send_sms: [:post, 'session/:session_id/appium/device/send_sms'],
  gsm_call: [:post, 'session/:session_id/appium/device/gsm_call'],
  gsm_signal: [:post, 'session/:session_id/appium/device/gsm_signal'],
  gsm_voice: [:post, 'session/:session_id/appium/device/gsm_voice'],
  set_network_speed: [:post, 'session/:session_id/appium/device/network_speed'],
  set_power_capacity: [:post, 'session/:session_id/appium/device/power_capacity'],
  set_power_ac: [:post, 'session/:session_id/appium/device/power_ac'],

  # For chromium: https://chromium.googlesource.com/chromium/src/+/master/chrome/test/chromedriver/server/http_handler.cc
  chrome_send_command: [:post, 'session/:session_id/goog/cdp/execute']
}.freeze

COMMAND_IOS =

{
  touch_id: [:post, 'session/:session_id/appium/simulator/touch_id'],
  toggle_touch_id_enrollment: [:post, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment']
}.freeze

COMMANDS =

{}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS).freeze