Module: Appium::Core::Waitable

Included in:

Driver

Defined in:

lib/appium_lib_core/common/wait.rb

Overview

module Wait

Instance Method Summary

• #wait(timeout: nil, interval: nil, message: nil, ignored: nil) ⇒ Object

  Check every interval seconds to see if yield doesn’t raise an exception.

• #wait_true(timeout: nil, interval: nil, message: nil, ignored: nil) ⇒ Object

  Check every interval seconds to see if yield returns a truthy value.

Instance Method Details

#wait(timeout: nil, interval: nil, message: nil, ignored: nil) ⇒ Object

Check every interval seconds to see if yield doesn’t raise an exception. Give up after timeout seconds.

If only a number is provided then it’s treated as the timeout value.

Examples:

@core.wait { @driver.find_element :accessibility_id, 'something' }

Parameters:

• timeout (Integer) (defaults to: nil) —

  Seconds to wait before timing out. Set default by appium_wait_timeout (30).

• interval (Integer) (defaults to: nil) —

  Seconds to sleep between polls. Set default by appium_wait_interval (0.5).

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

  Exception message if timed out.

• ignored (Array, Exception) (defaults to: nil) —

  Exceptions to ignore while polling (default: Exception)

# File 'lib/appium_lib_core/common/wait.rb', line 162

def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
  Wait.until(timeout: timeout || @wait_timeout,
             interval: interval || @wait_interval,
             message: message,
             ignored: ignored,
             object: self) { yield }
end

#wait_true(timeout: nil, interval: nil, message: nil, ignored: nil) ⇒ Object

Check every interval seconds to see if yield returns a truthy value. Note this isn’t a strict boolean true, any truthy value is accepted. false and nil are considered failures. Give up after timeout seconds.

If only a number is provided then it’s treated as the timeout value.

Examples:

@core.wait_true { @driver.find_element :accessibility_id, 'something' }

Parameters:

• timeout (Integer) (defaults to: nil) —

  Seconds to wait before timing out. Set default by appium_wait_timeout (30).

• interval (Integer) (defaults to: nil) —

  Seconds to sleep between polls. Set default by appium_wait_interval (0.5).

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

  Exception message if timed out.

• ignored (Array, Exception) (defaults to: nil) —

  Exceptions to ignore while polling (default: Exception)

# File 'lib/appium_lib_core/common/wait.rb', line 140

def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
  Wait.until_true(timeout: timeout || @wait_timeout,
                  interval: interval || @wait_interval,
                  message: message,
                  ignored: ignored,
                  object: self) { yield }
end