Web driver methods¶

Terms

element_id / parent_id

These are opaque values used by the driver to identify DOM elements.

Note: The driver should always accept an xpath locator as an id value
as well as id values returned from earlier driver calls

API

find_all( $parent_id, $locator, $scheme )

Returns the _id values for the elements to be instantiated, matching the $locator using "scheme".

Depending on array or scalar context, the return value is a list or an arrayref.

Note: there's no function to find a single element. That function is implemented on the "Weasel::Session" level.

get( $url )

Loads the page at $url into the driver's browser (browser emulator).

The $url passed in has been expanded by "Weasel::Session", prepending a registered prefix.

is_displayed($element_id)

Returns a boolean value indicating whether the element indicated by $element_id is interactable (can be selected, clicked on, etc)

wait_for( $callback, retry_timeout => $num, poll_delay => $num, on_timeout => \&cb )

The driver may interpret the 'poll_delay' in one of two ways:
1. The 'poll_delay' equals the number of seconds between the start of
successive poll requests
2. The 'poll_delay' equals the number of seconds to wait between the end
of one poll request and the start of the next

Since 0.03: Unless an "on_timeout" callback is provided, will "die" when the timeout has exceeded. Otherwise, call the provided callback.

Note: The user should catch inside the callback any exceptions that are
thrown inside the callback, unless such exceptions are allowed to
terminate further polling attempts.
I.e. this function doesn't guard against early termination by
catching exceptions.

clear($element_id)

Clicks on an element if an element id is provided, or on the current mouse location otherwise.

click( [ $element_id ] )

Clicks on an element if an element id is provided, or on the current mouse location otherwise.

dblclick()

Double clicks on the current mouse location.

get_attribute($element_id, $attribute_name)

Returns the value of the attribute named by $attribute_name of the element indicated by $element_id.

get_page_source($fh)

Writes a get_page_source of the browser's window to the filehandle $fh.

get_text($element_id)

Returns the HTML content of the element identified by $element_id, the so-called 'innerHTML'.

set_attribute($element_id, $attribute_name, $value)

DEPRECATED

Changes the value of the attribute named by $attribute_name to $value for the element identified by $element_id.

get_selected($element_id)

DEPRECATED

Please use "$self-"get_attribute('selected')> instead.

set_selected($element_id, $value)

DEPRECATED

Please use "$self-"set_attribute('selected', $value)> instead.

screenshot($fh)

Takes a screenshot and writes the image to the file handle $fh.

Note: In the current version of the driver, it's assumed the
driver writes a PNG image. Later versions may add APIs to
get/set the type of image generated.

send_keys($element_id, @keys)

Simulates key input into the element identified by $element_id.

@keys is an array of (groups of) inputs; multiple multi-character strings may be listed. In such cases the input will be appended. E.g.

  $driver->send_keys($element_id, "hello", ' ', "world");
    

is valid input to enter the text "hello world" into $element_id.

Note: Special keys are encoded according to the WebDriver spec.
In case a driver implementation needs differentt encoding of
special keys, this function should recode from the values
found in WebDriver::KEYS() to the desired code-set

tag_name($element_id)

The name of the HTML tag identified by $element_id.