appium_lib_core 4.1.0 → 5.8.0

data/lib/appium_lib_core/common/base/driver.rb

@@ -13,8 +13,15 @@
 # limitations under the License.
 
 require 'base64'
+require_relative 'device_ime'
+require_relative 'driver_settings'
 require_relative 'search_context'
 require_relative 'screenshot'
+require_relative 'rotable'
+require_relative 'remote_status'
+require_relative 'has_location'
+require_relative 'has_network_connection'
+require_relative '../wait'
 
 module Appium
   module Core
@@ -22,42 +29,65 @@ module Appium
       class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::UploadsFiles
         include ::Selenium::WebDriver::DriverExtensions::HasSessionId
-        include ::Selenium::WebDriver::DriverExtensions::Rotatable
-        include ::Selenium::WebDriver::DriverExtensions::HasRemoteStatus
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
+        include ::Appium::Core::Base::Rotatable
         include ::Appium::Core::Base::SearchContext
-        include ::Appium::Core::Base::TakeScreenshot
+        include ::Appium::Core::Base::TakesScreenshot
+        include ::Appium::Core::Base::HasRemoteStatus
+        include ::Appium::Core::Base::HasLocation
+        include ::Appium::Core::Base::HasNetworkConnection
+
+        include ::Appium::Core::Waitable
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
 
-        def initialize(opts = {})
-          listener = opts.delete(:listener)
-          @bridge = ::Appium::Core::Base::Bridge.handshake(**opts)
-          if @bridge.dialect == :oss # MJSONWP
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          elsif @bridge.dialect == :w3c
-            # TODO: Only for Appium. Ideally, we'd like to remove the below like selenium-webdriver
-            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
-            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
-            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
-          end
-          super(@bridge, listener: listener)
+        private
+
+        def initialize(bridge: nil, listener: nil, **opts)
+          # For ::Appium::Core::Waitable
+          @wait_timeout = opts.delete(:wait_timeout)
+          @wait_interval = opts.delete(:wait_interval)
+
+          super
         end
 
-        # Get the dialect value
-        # @return [:oss|:w3c]
-        def dialect
-          @bridge.dialect
+        # Create a proper bridge instance.
+        #
+        # @return [::Appium::Core::Base::Bridge]
+        #
+        def create_bridge(**opts)
+          # for a new session request
+          capabilities = opts.delete(:capabilities)
+          bridge_opts = { http_client: opts.delete(:http_client), url: opts.delete(:url) }
+
+          # for attaching to an existing session
+          session_id = opts.delete(:existing_session_id)
+          automation_name = opts.delete(:automation_name)
+          platform_name = opts.delete(:platform_name)
+
+          raise ::Appium::Core::Error::ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
+
+          bridge = ::Appium::Core::Base::Bridge.new(**bridge_opts)
+
+          if session_id.nil?
+            bridge.create_session(capabilities)
+          else
+            # attach to the existing session id
+            bridge.attach_to(session_id, platform_name, automation_name)
+          end
+
+          bridge
         end
 
+        public
+
         # Update +server_url+ and HTTP clients following this arguments, protocol, host, port and path.
         # After this method, +@bridge.http+ will be a new instance following them instead of +server_url+ which is
         # set before creating session.
+        # If +@bridge.http+ did not have +update_sending_request_to+ method, this method returns immediately.
         #
         # @example
         #
@@ -66,14 +96,124 @@ module Appium
         #     driver.manage.timeouts.implicit_wait = 10 # @bridge.http is for 'https://example2.com:9000/wd/hub/'
         #
         def update_sending_request_to(protocol:, host:, port:, path:)
-          @bridge.http.update_sending_request_to(scheme: protocol,
-                                                 host: host,
-                                                 port: port,
-                                                 path: path)
+          unless @bridge.http&.class&.method_defined? :update_sending_request_to
+            ::Appium::Logger.warn "#{@bridge.http&.class} has no 'update_sending_request_to'. " \
+                                  'It keeps current connection target.'
+            return
+          end
+
+          @bridge.http&.update_sending_request_to(scheme: protocol,
+                                                  host: host,
+                                                  port: port,
+                                                  path: path)
+        end
+
+        AVAILABLE_METHODS = [
+          :get, :head, :post, :put, :delete,
+          :connect, :options, :trace, :patch
+        ].freeze
+        # Define a new custom method to the driver so that you can define your own method for
+        # drivers/plugins in Appium 2.0. Appium 2.0 and its custom drivers/plugins allow you
+        # to define custom commands that are not part of W3C spec.
+        #
+        # @param [Symbol] method HTTP request method as https://www.w3.org/TR/webdriver/#endpoints
+        # @param [string] url The url to URL template as https://www.w3.org/TR/webdriver/#endpoints.
+        #                     +:session_id+ is the placeholder of 'session id'.
+        #                     Other place holders can be specified with +:+ prefix like +:id+.
+        #                     Then, the +:id+ will be replaced with a given value as the seconds argument of +execute+
+        # @param [Symbol] name The name of method that is called as the driver instance method.
+        # @param [Proc] block The block to involve as the method.
+        #                     Please define a method that has the same +name+ with arguments you want.
+        #                     The method must has +execute+ method. tHe +execute+ is calls the +url+
+        #                     with the given parameters.
+        #                     The first argument should be +name+ as symbol.
+        #                     The second argument should be hash. If keys in the hash matches +:+ prefix
+        #                     string in the given url, the matched string in the given url will be
+        #                     values in the hash.
+        #                     The third argument should be hash. The hash will be the request body.
+        #                     Please read examples below for more details.
+        # @raise [ArgumentError] If the given +method+ is invalid value.
+        #
+        # @example
+        #
+        #   @driver.add_command(
+        #     method: :get,
+        #     url: 'session/:session_id/path/to/custom/url',
+        #     name: :test_command
+        #   )
+        #   # Send a GET request to 'session/<session id>/path/to/custom/url'
+        #   @driver.test_command
+        #
+        #
+        #   @driver.add_command(
+        #     method: :post,
+        #     url: 'session/:session_id/path/to/custom/url',
+        #     name: :test_command
+        #   ) do
+        #     def test_command(argument)
+        #       execute(:test_command, {}, { dummy: argument })
+        #     end
+        #   end
+        #   # Send a POST request to 'session/<session id>/path/to/custom/url'
+        #   # with body "{ dummy: 1 }" as JSON object. "1" is the argument.
+        #   # ':session_id' in the given 'url' is replaced with current 'session id'.
+        #   @driver.test_command(1)
+        #
+        #
+        #   @driver.add_command(
+        #     method: :post,
+        #     url: 'session/:session_id/element/:id/custom/action',
+        #     name: :test_action_command
+        #   ) do
+        #     def test_action_command(element_id, action)
+        #       execute(:test_action_command, {id: element_id}, { dummy_action: action })
+        #     end
+        #   end
+        #   # Send a POST request to 'session/<session id>/element/<element id>/custom/action'
+        #   # with body "{ dummy_action: #{action} }" as JSON object. "action" is the seconds argument.
+        #   # ':session_id' in the given url is replaced with current 'session id'.
+        #   # ':id' in the given url is replaced with the given 'element_id'.
+        #   e = @driver.find_element :accessibility_id, 'an element'
+        #   @driver.test_action_command(e.id, 'action')
+        #
+        def add_command(method:, url:, name:, &block)
+          unless AVAILABLE_METHODS.include? method
+            raise ::Appium::Core::Error::ArgumentError, "Available method is either #{AVAILABLE_METHODS}"
+          end
+
+          # TODO: Remove this logger before Appium 2.0 release
+          ::Appium::Logger.info '[Experimental] this method is experimental for Appium 2.0. This interface may change.'
+
+          @bridge.add_command method: method, url: url, name: name, &block
         end
 
         ### Methods for Appium
 
+        # Perform 'key' actions for W3C module.
+        # Generate +key+ pointer action here and users can use this via +driver.key_action+
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
+        # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
+        #
+        # The pointer type is 'key' by default in the Appium Ruby client.
+        # +driver.action+ in Appium Ruby client has 'pointer' action by default.
+        # This method is a shortcut to set 'key' type.
+        # Hense this method is equal to +driver.action(devices: [::Selenium::WebDriver::Interactions.key('keyboard')])+
+        # as below example.
+        #
+        # @example
+        #
+        #     element = @driver.find_element(:id, "some id")
+        #     @driver.key_action.send_key('hiあ').perform # The 'send_key' is a part of 'KeyActions'
+        #     # is equal to:
+        #     # @driver.action(devices: [::Selenium::WebDriver::Interactions.key('keyboard')]).send_keys('hiあ').perform
+        #
+        def key_action(async: false)
+          @bridge.action(
+            async: async,
+            devices: [::Selenium::WebDriver::Interactions.key('keyboard')]
+          )
+        end
+
         # Lock the device
         # @return [String]
         #
@@ -138,38 +278,6 @@ module Appium
         end
         alias is_keyboard_shown keyboard_shown?
 
-        # [DEPRECATION]
-        # Send keys for a current active element
-        # @param [String] key Input text
-        #
-        # @example
-        #
-        #   @driver.send_keys 'happy testing!'
-        #
-        def send_keys(*key)
-          ::Appium::Logger.warn(
-            '[DEPRECATION] Driver#send_keys is deprecated in W3C spec. Use driver.action.<command>.perform instead'
-          )
-          @bridge.send_keys_to_active_element(key)
-        end
-        alias type send_keys
-
-        class DriverSettings
-          # @private this class is private
-          def initialize(bridge)
-            @bridge = bridge
-          end
-
-          def get
-            @bridge.get_settings
-          end
-
-          def update(settings)
-            @bridge.update_settings(settings)
-          end
-        end
-        private_constant :DriverSettings
-
         # Returns an instance of DriverSettings to call get/update.
         #
         # @example
@@ -178,7 +286,7 @@ module Appium
         #   @driver.settings.update('allowInvisibleElements': true)
         #
         def settings
-          @driver_settings ||= DriverSettings.new(@bridge) # rubocop:disable Naming/MemoizedInstanceVariableName
+          @settings ||= DriverSettings.new(@bridge)
         end
 
         # Get appium Settings for current test session.
@@ -200,8 +308,8 @@ module Appium
         #
         # @example
         #
-        #   @driver.update_settings('allowInvisibleElements': true)
-        #   @driver.settings.update('allowInvisibleElements': true)
+        #   @driver.update_settings({ 'allowInvisibleElements': true })
+        #   @driver.settings.update({ 'allowInvisibleElements': true })
         #   @driver.settings = { 'allowInvisibleElements': true }
         #
         def settings=(value)
@@ -209,36 +317,10 @@ module Appium
         end
         alias update_settings settings=
 
-        class DeviceIME
-          # @private this class is private
-          def initialize(bridge)
-            @bridge = bridge
-          end
-
-          def activate(ime_name)
-            @bridge.ime_activate(ime_name)
-          end
-
-          def available_engines
-            @bridge.ime_available_engines
-          end
-
-          def active_engine
-            @bridge.ime_active_engine
-          end
-
-          def activated?
-            @bridge.ime_activated
-          end
-
-          def deactivate
-            @bridge.ime_deactivate
-          end
-        end
-        private_constant :DeviceIME
-
         # Returns an instance of DeviceIME
         #
+        # @return [Appium::Core::Base::Driver::DeviceIME]
+        #
         # @example
         #
         #   @driver.ime.activate engine: 'com.android.inputmethod.latin/.LatinIME'
@@ -248,7 +330,7 @@ module Appium
         #   @driver.ime.deactivate #=> Deactivate current IME engine
         #
         def ime
-          @device_ime ||= DeviceIME.new(@bridge) # rubocop:disable Naming/MemoizedInstanceVariableName
+          @ime ||= DeviceIME.new(@bridge)
         end
 
         # Android only. Make an engine that is available active.
@@ -289,6 +371,8 @@ module Appium
         # @!method ime_activated
         #   Android only. Indicates whether IME input is active at the moment (not if it is available).
         #
+        # @return [Boolean]
+        #
         # @example
         #
         #   @driver.ime_activated #=> True if IME is activated
@@ -366,42 +450,10 @@ module Appium
         end
         alias set_context context=
 
-        # Set the value to element directly
-        #
-        # @example
-        #
-        #   @driver.set_immediate_value element, 'hello'
-        #
-        def set_immediate_value(element, *value)
-          ::Appium::Logger.warn '[DEPRECATION] driver#set_immediate_value(element, *value) is deprecated. ' \
-            'Use Element#immediate_value(*value) instead'
-          @bridge.set_immediate_value(element, *value)
-        end
-
-        # Replace the value to element directly
-        #
-        # @example
-        #
-        #   @driver.replace_value element, 'hello'
-        #
-        def replace_value(element, *value)
-          ::Appium::Logger.warn '[DEPRECATION] driver#replace_value(element, *value) is deprecated. ' \
-            'Use Element#replace_value(*value) instead'
-          @bridge.replace_value(element, *value)
-        end
-
         # Place a file in a specific location on the device.
-        # On iOS, the server should have ifuse libraries installed and configured properly for this feature to work on
-        # real devices.
         # On Android, the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pushed to the root of
         #                      the corresponding application container.
@@ -418,18 +470,10 @@ module Appium
           @bridge.push_file(path, filedata)
         end
 
-        # Pull a file from the simulator/device.
-        # On iOS the server should have ifuse
-        # libraries installed and configured properly for this feature to work on real devices.
+        # Pull a file from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access
         # to its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Either an absolute path OR, for iOS devices, a path relative to the app, as described.
         #                      If the path starts with application id prefix, then the file will be pulled from the root
         #                      of the corresponding application container.
@@ -438,7 +482,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data
         #
@@ -455,18 +498,10 @@ module Appium
           @bridge.pull_file(path)
         end
 
-        # Pull a folder content from the simulator/device.
-        # On iOS the server should have ifuse libraries installed and configured properly for this feature to work
-        # on real devices.
+        # Pull a folder content from the remote device.
         # On Android the application under test should be built with debuggable flag enabled in order to get access to
         # its container on the internal file system.
         #
-        # {https://github.com/libimobiledevice/ifuse iFuse GitHub page6}
-        #
-        # {https://github.com/osxfuse/osxfuse/wiki/FAQ osxFuse FAQ}
-        #
-        # {https://developer.android.com/studio/debug 'Debug Your App' developer article}
-        #
         # @param [String] path Absolute path to the folder.
         #                      If the path starts with <em>@applicationId/</em> prefix, then the folder will be pulled
         #                      from the root of the corresponding application container.
@@ -475,7 +510,6 @@ module Appium
         #                      Only pulling files from application containers is supported for iOS Simulator.
         #                      Provide the remote path in format
         #                      <code>@bundle.identifier:container_type/relative_path_in_container</code>
-        #                      (Make sure this in ifuse doc)
         #
         # @return [Base64-decoded] Base64 decoded data which is zip archived
         #
@@ -489,19 +523,6 @@ module Appium
           @bridge.pull_folder(path)
         end
 
-        # Send keyevent on the device.(Only for Selendroid)
-        # http://developer.android.com/reference/android/view/KeyEvent.html
-        # @param [integer] key The key to press.
-        # @param [String] metastate The state the metakeys should be in when pressing the key.
-        #
-        # @example
-        #
-        #   @driver.keyevent 82
-        #
-        def keyevent(key, metastate = nil)
-          @bridge.keyevent(key, metastate)
-        end
-
         # Press keycode on the device.
         # http://developer.android.com/reference/android/view/KeyEvent.html
         # @param [Integer] key The key to press. The values which have +KEYCODE_+ prefix in http://developer.android.com/reference/android/view/KeyEvent.html
@@ -546,6 +567,7 @@ module Appium
           @bridge.long_press_keycode(key, metastate: metastate, flags: flags)
         end
 
+        # @deprecated Except for Windows
         # Start the simulator and application configured with desired capabilities
         #
         # @example
@@ -556,6 +578,7 @@ module Appium
           @bridge.launch_app
         end
 
+        # @deprecated Except for Windows
         # Close an app on device
         #
         # @example
@@ -566,6 +589,7 @@ module Appium
           @bridge.close_app
         end
 
+        # @deprecated
         # Reset the device, relaunching the application.
         #
         # @example
@@ -573,6 +597,10 @@ module Appium
         #   @driver.reset
         #
         def reset
+          ::Appium::Logger.warn(
+            '[DEPRECATION] reset is deprecated. Please use terminate_app and activate_app, ' \
+            'or quit and create a new session instead.'
+          )
           @bridge.reset
         end
 
@@ -602,7 +630,9 @@ module Appium
           @bridge.background_app(duration)
         end
 
-        # Install the given app onto the device
+        # Install the given app onto the device.
+        # Each options can be snake-case or camel-case. Snake-cases will be converted to camel-case
+        # as options value.
         #
         # @param [String] path The absolute local path or remote http URL to an .ipa or .apk file,
         #                      or a .zip containing one of these.
@@ -616,26 +646,26 @@ module Appium
         # @param [Boolean] grant_permissions Only for Android. whether to automatically grant application permissions
         #                                    on Android 6+ after the installation completes. +false+ by default
         #
+        # Other parameters such as https://github.com/appium/appium-xcuitest-driver#mobile-installapp also can be set.
+        # Then, arguments in snake case will be camel case as its request parameters.
+        #
         # @example
         #
         #   @driver.install_app("/path/to/test.apk")
         #   @driver.install_app("/path/to/test.apk", replace: true, timeout: 20000, allow_test_packages: true,
         #                       use_sdcard: false, grant_permissions: false)
+        #   @driver.install_app("/path/to/test.ipa", timeoutMs: 20000)
         #
-        def install_app(path,
-                        replace: nil,
-                        timeout: nil,
-                        allow_test_packages: nil,
-                        use_sdcard: nil,
-                        grant_permissions: nil)
-          @bridge.install_app(path,
-                              replace: replace,
-                              timeout: timeout,
-                              allow_test_packages: allow_test_packages,
-                              use_sdcard: use_sdcard,
-                              grant_permissions: grant_permissions)
+        def install_app(path, **options)
+          options = options.transform_keys { |key| key.to_s.gsub(/_./) { |v| v[1].upcase } } unless options.nil?
+          @bridge.install_app(path, options)
         end
 
+        # def capitalize(s)
+        #   chars =
+        #   chars[1:].map(&:capitalize).join
+        # end
+
         # @param [Strong] app_id BundleId for iOS or package name for Android
         # @param [Boolean] keep_data Only for Android. Whether to keep application data and caches after it is uninstalled.
         #                             +false+ by default
@@ -790,7 +820,7 @@ module Appium
         #
         # @example: Zoom
         #
-        #    f1 = @driver.action.add_pointer_input(:touch, 'finger1')
+        #    f1 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger1')
         #    f1.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_down(:left)
@@ -798,7 +828,7 @@ module Appium
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f1.create_pointer_up(:left)
         #
-        #    f2 = @driver.action.add_pointer_input(:touch, 'finger2')
+        #    f2 = ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'finger2')
         #    f2.create_pointer_move(duration: 1, x: 200, y: 500,
         #                           origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
         #    f2.create_pointer_down(:left)
@@ -809,7 +839,11 @@ module Appium
         #    @driver.perform_actions [f1, f2] #=> 'nil' if the action succeed
         #
         def perform_actions(data)
-          raise ArgumentError, "'#{data}' must be Array" unless data.is_a? Array
+          raise ::Appium::Core::Error::ArgumentError, "'#{data}' must be Array" unless data.is_a? Array
+
+          # NOTE: 'add_input' in Selenium Ruby implementation has additional 'pause'.
+          # This implementation is to avoid the additional pause.
+          # https://github.com/SeleniumHQ/selenium/blob/64447d4b03f6986337d1ca8d8b6476653570bcc1/rb/lib/selenium/webdriver/common/action_builder.rb#L207
 
           @bridge.send_actions data.map(&:encode).compact
           data.each(&:clear_actions)
@@ -853,7 +887,7 @@ module Appium
         end
 
         # Get the device window's logs.
-        # @return [String]
+        # @return [Appium::Core::Logs]
         #
         # @example
         #
@@ -879,16 +913,15 @@ module Appium
         # Retrieve the capabilities of the specified session.
         # It's almost same as +@driver.capabilities+ but you can get more details.
         #
-        # @return [Selenium::WebDriver::Remote::Capabilities]
+        # @return [Selenium::WebDriver::Remote::Capabilities, Selenium::WebDriver::Remote::Capabilities]
         #
         # @example
         #   @driver.session_capabilities
         #
         #   #=> uiautomator2
-        #   # <Selenium::WebDriver::Remote::W3C::Capabilities:0x007fa38dae1360
+        #   # <Selenium::WebDriver::Remote::Capabilities:0x007fa38dae1360
         #   # @capabilities=
-        #   #     {:proxy=>nil,
-        #   #      :browser_name=>nil,
+        #   #     {:browser_name=>nil,
         #   #      :browser_version=>nil,
         #   #      :platform_name=>"android",
         #   #      :page_load_strategy=>nil,
@@ -935,10 +968,9 @@ module Appium
         #   #      "viewportRect"=>{"left"=>0, "top"=>63, "width"=>1080, "height"=>1731}}>
         #   #
         #   #=> XCUITest
-        #   # <Selenium::WebDriver::Remote::W3C::Capabilities:0x007fb15dc01370
+        #   # <Selenium::WebDriver::Remote::Capabilities:0x007fb15dc01370
         #   # @capabilities=
-        #   #     {:proxy=>nil,
-        #   #      :browser_name=>"UICatalog",
+        #   #     {:browser_name=>"UICatalog",
         #   #      :browser_version=>nil,
         #   #      :platform_name=>"ios",
         #   #      :page_load_strategy=>nil,
@@ -992,11 +1024,14 @@ module Appium
                                         visualize: visualize)
         end
 
-        def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil)
+        def find_image_occurrence(full_image:, partial_image:, visualize: false, threshold: nil,
+                                  multiple: nil, match_neighbour_threshold: nil)
           @bridge.find_image_occurrence(full_image: full_image,
                                         partial_image: partial_image,
                                         visualize: visualize,
-                                        threshold: threshold)
+                                        threshold: threshold,
+                                        multiple: multiple,
+                                        match_neighbour_threshold: match_neighbour_threshold)
         end
 
         def get_images_similarity(first_image:, second_image:, visualize: false)
@@ -1009,14 +1044,14 @@ module Appium
 
         # @since Appium 1.8.2
         # Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
-        # {https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md image-comparison}
+        # {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
         #
         # You can handle settings for the comparision following below.
         # {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 device-settings}
         #
         # @param [String] img_path A path to a partial image you'd like to find
         #
-        # @return [::Selenium::WebDriver::Element]
+        # @return [::Appium::Core::Element]
         #
         # @example
         #
@@ -1031,14 +1066,14 @@ module Appium
 
         # @since Appium 1.8.2
         # Return elements if current view has a partial image. The logic depends on template matching by OpenCV.
-        # {https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md image-comparison}
+        # {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
         #
         # You can handle settings for the comparision following below.
         # {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 device-settings}
         #
         # @param [String] img_path A path to a partial image you'd like to find
         #
-        # @return [::Selenium::WebDriver::Element]
+        # @return [Array<Selenium::WebDriver::Element>]
         #
         # @example
         #
@@ -1086,14 +1121,14 @@ module Appium
           @bridge.execute_driver(script: script, type: type, timeout_ms: timeout_ms)
         end
 
-        # Convert vanilla element response to ::Selenium::WebDriver::Element
+        # Convert vanilla element response to ::Appium::Core::Element
         #
         # @param [Hash] id The id which can get as a response from server
-        # @return [::Selenium::WebDriver::Element]
+        # @return [::Appium::Core::Element]
         #
         # @example
         #     response = {"element-6066-11e4-a52e-4f735466cecf"=>"xxxx", "ELEMENT"=>"xxxx"}
-        #     ele = @driver.convert_to_element(response) #=> ::Selenium::WebDriver::Element
+        #     ele = @driver.convert_to_element(response) #=> ::Appium::Core::Element
         #     ele.rect #=> Can get the rect of the element
         #
         def convert_to_element(id)