Module: Selenium::WebDriver::DriverExtensions::HasSessionEvents Private

Included in:

Remote::Driver

Defined in:

lib/selenium/webdriver/common/driver_extensions/has_session_events.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Instance Method Summary

• #fire_session_event(event_type, payload = nil) ⇒ Hash private

  Fires a custom session event to the remote server event bus.

Instance Method Details

#fire_session_event(event_type, payload = nil) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Fires a custom session event to the remote server event bus. This allows test code to trigger server-side utilities that subscribe to the event bus.

Examples:

Fire a simple event

driver.fire_session_event("test:started")

Fire an event with payload

driver.fire_session_event("test:failed", {
  testName: "LoginTest",
  error: "Element not found"
})

Parameters:

• event_type (String) —

  The type of event (e.g., “test:failed”, “log:collect”)

• payload (Hash) (defaults to: nil) —

  Optional data to include with the event

Returns:

• (Hash) —

  Response data including success status, event type, and timestamp

# File 'lib/selenium/webdriver/common/driver_extensions/has_session_events.rb', line 42

def fire_session_event(event_type, payload = nil)
  @bridge.fire_session_event(event_type, payload)
end