Inheritance diagram for SeleniumLibrary.keywords.waiting.WaitingKeywords:

Public Member Functions
def	wait_for_condition (self, condition, timeout=None, error=None)
	Waits until `condition` is true or `timeout` expires. More...

def	wait_until_element_contains (self, locator, text, timeout=None, error=None)
	Waits until element `locator` contains `text`. More...

def	wait_until_element_does_not_contain (self, locator, text, timeout=None, error=None)
	Waits until element `locator` does not contain `text`. More...

def	wait_until_element_is_enabled (self, locator, timeout=None, error=None)
	Waits until element `locator` is enabled. More...

def	wait_until_element_is_not_visible (self, locator, timeout=None, error=None)
	Waits until element `locator` is not visible. More...

def	wait_until_element_is_visible (self, locator, timeout=None, error=None)
	Waits until element `locator` is visible. More...

def	wait_until_location_contains (self, expected, timeout=None, message=None)
	Wait until that current URL contains `expected`. More...

def	wait_until_location_is (self, expected, timeout=None, message=None)
	Wait until that current URL is `expected`. More...

def	wait_until_page_contains (self, text, timeout=None, error=None)
	Waits until `text` appears on current page. More...

def	wait_until_page_contains_element (self, locator, timeout=None, error=None)
	Waits until element `locator` appears on current page. More...

def	wait_until_page_does_not_contain (self, text, timeout=None, error=None)
	Waits until `text` disappears from current page. More...

def	wait_until_page_does_not_contain_element (self, locator, timeout=None, error=None)
	Waits until element `locator` disappears from current page. More...

Public Member Functions inherited from SeleniumLibrary.base.librarycomponent.LibraryComponent
def	assert_page_contains (self, locator, tag=None, message=None, loglevel='TRACE')

def	assert_page_not_contains (self, locator, tag=None, message=None, loglevel='TRACE')

def	debug (self, msg, html=False)

def	get_timeout (self, timeout=None)

def	info (self, msg, html=False)

def	log (self, msg, level='INFO', html=False)

def	log_source (self, loglevel='INFO')

def	warn (self, msg, html=False)

Public Member Functions inherited from SeleniumLibrary.base.context.ContextAware
def	__init__ (self, ctx)
	Base class exposing attributes from the common context. More...

def	find_element (self, locator, tag=None, required=True, parent=None)
	Find element matching `locator`. More...

def	find_elements (self, locator, tag=None, parent=None)
	Find all elements matching `locator`. More...

def	is_element_enabled (self, locator, tag=None)

def	is_text_present (self, text)

def	is_visible (self, locator)

Private Member Functions
def	_wait_until (self, condition, error, timeout=None, custom_error=None)

def	_wait_until_worker (self, condition, timeout, error)

Additional Inherited Members
Public Attributes inherited from SeleniumLibrary.base.context.ContextAware
	ctx

Properties inherited from SeleniumLibrary.base.librarycomponent.LibraryComponent
	log_dir = property

Properties inherited from SeleniumLibrary.base.context.ContextAware
	driver = property

	drivers = property

	element_finder = property

Detailed Description

Definition at line 26 of file waiting.py.

Member Function Documentation

◆ _wait_until()

def SeleniumLibrary.keywords.waiting.WaitingKeywords._wait_until	(	self,
		condition,
		error,
		timeout = `None`,
		custom_error = `None`
	)

private

Definition at line 258 of file waiting.py.

◆ _wait_until_worker()

def SeleniumLibrary.keywords.waiting.WaitingKeywords._wait_until_worker	(	self,
		condition,
		timeout,
		error
	)

private

Definition at line 266 of file waiting.py.

◆ wait_for_condition()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_for_condition	(	self,
		condition,
		timeout = `None`,
		error = `None`
	)

Waits until condition is true or timeout expires.

    The condition can be arbitrary JavaScript expression but it
    must return a value to be evaluated. See `Execute JavaScript` for
    information about accessing content on pages.

    Fails if the timeout expires before the condition becomes true. See
    the `Timeouts` section for more information about using timeouts
    and their default value.

    ``error`` can be used to override the default error message.

    Examples:
    | `Wait For Condition` | return document.title == "New Title" |
    | `Wait For Condition` | return jQuery.active == 0            |
    | `Wait For Condition` | style = document.querySelector('h1').style; return style.background == "red" && style.color == "white" |

Definition at line 46 of file waiting.py.

◆ wait_until_element_contains()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_element_contains	(	self,
		locator,
		text,
		timeout = `None`,
		error = `None`
	)

Waits until element locator contains text.

    Fails if ``timeout`` expires before the text appears. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 232 of file waiting.py.

◆ wait_until_element_does_not_contain()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_element_does_not_contain	(	self,
		locator,
		text,
		timeout = `None`,
		error = `None`
	)

Waits until element locator does not contain text.

    Fails if ``timeout`` expires before the text disappears. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 250 of file waiting.py.

◆ wait_until_element_is_enabled()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_element_is_enabled	(	self,
		locator,
		timeout = `None`,
		error = `None`
	)

Waits until element locator is enabled.

    Element is considered enabled if it is not disabled nor read-only.

    Fails if ``timeout`` expires before the element is enabled. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

    Considering read-only elements to be disabled is a new feature
    in SeleniumLibrary 3.0.

Definition at line 214 of file waiting.py.

◆ wait_until_element_is_not_visible()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_element_is_not_visible	(	self,
		locator,
		timeout = `None`,
		error = `None`
	)

Waits until element locator is not visible.

    Fails if ``timeout`` expires before the element is not visible. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 191 of file waiting.py.

◆ wait_until_element_is_visible()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_element_is_visible	(	self,
		locator,
		timeout = `None`,
		error = `None`
	)

Waits until element locator is visible.

    Fails if ``timeout`` expires before the element is visible. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 173 of file waiting.py.

◆ wait_until_location_contains()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_location_contains	(	self,
		expected,
		timeout = `None`,
		message = `None`
	)

Wait until that current URL contains expected.

    The ``expected`` argument contains the expected value in url.

    Fails if ``timeout`` expires before the location contains. See
    the `Timeouts` section for more information about using timeouts
    and their default value.

    The ``message`` argument can be used to override the default error
    message.

    New in SeleniumLibrary 4.0

Definition at line 91 of file waiting.py.

◆ wait_until_location_is()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_location_is	(	self,
		expected,
		timeout = `None`,
		message = `None`
	)

Wait until that current URL is expected.

    The ``expected`` argument is the expected value in url.

    Fails if ``timeout`` expires before the location is. See
    the `Timeouts` section for more information about using timeouts
    and their default value.

    The ``message`` argument can be used to override the default error
    message.

    New in SeleniumLibrary 4.0

Definition at line 70 of file waiting.py.

◆ wait_until_page_contains()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_page_contains	(	self,
		text,
		timeout = `None`,
		error = `None`
	)

Waits until text appears on current page.

    Fails if ``timeout`` expires before the text appears. See
    the `Timeouts` section for more information about using timeouts
    and their default value.

    ``error`` can be used to override the default error message.

Definition at line 107 of file waiting.py.

◆ wait_until_page_contains_element()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_page_contains_element	(	self,
		locator,
		timeout = `None`,
		error = `None`
	)

Waits until element locator appears on current page.

    Fails if ``timeout`` expires before the element appears. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 137 of file waiting.py.

◆ wait_until_page_does_not_contain()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_page_does_not_contain	(	self,
		text,
		timeout = `None`,
		error = `None`
	)

Waits until text disappears from current page.

    Fails if ``timeout`` expires before the text disappears. See
    the `Timeouts` section for more information about using timeouts
    and their default value.

    ``error`` can be used to override the default error message.

Definition at line 121 of file waiting.py.

◆ wait_until_page_does_not_contain_element()

def SeleniumLibrary.keywords.waiting.WaitingKeywords.wait_until_page_does_not_contain_element	(	self,
		locator,
		timeout = `None`,
		error = `None`
	)

Waits until element locator disappears from current page.

    Fails if ``timeout`` expires before the element disappears. See
    the `Timeouts` section for more information about using timeouts and
    their default value and the `Locating elements` section for details
    about the locator syntax.

    ``error`` can be used to override the default error message.

Definition at line 155 of file waiting.py.

The documentation for this class was generated from the following file:

src/SeleniumLibrary/keywords/waiting.py

Public Member Functions

Private Member Functions

Additional Inherited Members