Struct BrowserSession 

pub struct BrowserSession { /* private fields */ }

Available on crate feature browser only.

A browser session that wraps thirtyfour’s WebDriver.

This is the core abstraction for browser automation in ADK. It can be shared across multiple tools via Arc<BrowserSession>.

Implementations

impl BrowserSession

pub fn new(config: BrowserConfig) -> BrowserSession

Create a new browser session with the given configuration.

Note: This does not start the browser immediately. Call start() to initialize the WebDriver connection.

pub fn with_defaults() -> BrowserSession

Create a browser session with default configuration.

pub async fn start(&self) -> Result<(), AdkError>

Start the browser session by connecting to WebDriver.

pub async fn stop(&self) -> Result<(), AdkError>

Stop the browser session.

pub async fn is_active(&self) -> bool

Check if the session is active by verifying the WebDriver connection is alive.

pub async fn ensure_started(&self) -> Result<(), AdkError>

Ensure the browser session is started, reconnecting if the session died.

Call this instead of checking is_active() manually. If the session exists but is stale (WebDriver died), it will be recreated transparently.

pub async fn page_context(&self) -> Result<Value, AdkError>

Get a snapshot of the current page context (url, title, truncated body text).

Useful for returning page state after interaction tools.

pub fn config(&self) -> &BrowserConfig

Get the configuration.

pub async fn navigate(&self, url: &str) -> Result<(), AdkError>

Navigate to a URL.

pub async fn current_url(&self) -> Result<String, AdkError>

Get the current URL.

pub async fn title(&self) -> Result<String, AdkError>

Get the page title.

pub async fn find_element(&self, selector: &str) -> Result<WebElement, AdkError>

Find an element by CSS selector.

pub async fn find_elements( &self, selector: &str, ) -> Result<Vec<WebElement>, AdkError>

Find multiple elements by CSS selector.

pub async fn find_by_xpath(&self, xpath: &str) -> Result<WebElement, AdkError>

Find element by XPath.

pub async fn click(&self, selector: &str) -> Result<(), AdkError>

Click an element by selector.

pub async fn type_text( &self, selector: &str, text: &str, ) -> Result<(), AdkError>

Type text into an element.

pub async fn clear(&self, selector: &str) -> Result<(), AdkError>

Clear an input field.

pub async fn get_text(&self, selector: &str) -> Result<String, AdkError>

Get text content of an element.

pub async fn get_attribute( &self, selector: &str, attribute: &str, ) -> Result<Option<String>, AdkError>

Get an attribute value.

pub async fn screenshot(&self) -> Result<String, AdkError>

Take a screenshot (returns base64-encoded PNG).

pub async fn screenshot_element( &self, selector: &str, ) -> Result<String, AdkError>

Take a screenshot of a specific element.

pub async fn execute_script(&self, script: &str) -> Result<Value, AdkError>

Execute JavaScript and return result.

pub async fn execute_async_script( &self, script: &str, ) -> Result<Value, AdkError>

Execute async JavaScript and return result.

pub async fn wait_for_element( &self, selector: &str, timeout_secs: u64, ) -> Result<WebElement, AdkError>

Wait for an element to be present.

pub async fn wait_for_clickable( &self, selector: &str, timeout_secs: u64, ) -> Result<WebElement, AdkError>

Wait for an element to be clickable.

pub async fn page_source(&self) -> Result<String, AdkError>

Get page source HTML.

pub async fn back(&self) -> Result<(), AdkError>

Go back in history.

pub async fn forward(&self) -> Result<(), AdkError>

Go forward in history.

pub async fn refresh(&self) -> Result<(), AdkError>

Refresh the current page.

pub async fn get_all_cookies(&self) -> Result<Vec<Value>, AdkError>

Get all cookies.

pub async fn get_cookie(&self, name: &str) -> Result<Value, AdkError>

Get a cookie by name.

pub async fn add_cookie( &self, name: &str, value: &str, domain: Option<&str>, path: Option<&str>, secure: Option<bool>, expiry: Option<i64>, ) -> Result<(), AdkError>

Add a cookie.

pub async fn delete_cookie(&self, name: &str) -> Result<(), AdkError>

Delete a cookie.

pub async fn delete_all_cookies(&self) -> Result<(), AdkError>

Delete all cookies.

pub async fn list_windows(&self) -> Result<(Vec<String>, String), AdkError>

List all windows/tabs.

pub async fn new_tab(&self) -> Result<String, AdkError>

Open a new tab.

pub async fn new_window(&self) -> Result<String, AdkError>

Open a new window.

pub async fn switch_to_window(&self, handle: &str) -> Result<(), AdkError>

Switch to a window by handle.

pub async fn close_window(&self) -> Result<(), AdkError>

Close the current window.

pub async fn maximize_window(&self) -> Result<(), AdkError>

Maximize window.

pub async fn minimize_window(&self) -> Result<(), AdkError>

Minimize window.

pub async fn set_window_rect( &self, x: i32, y: i32, width: u32, height: u32, ) -> Result<(), AdkError>

Set window size and position.

pub async fn switch_to_frame_by_index(&self, index: u16) -> Result<(), AdkError>

Switch to frame by index.

pub async fn switch_to_frame_by_selector( &self, selector: &str, ) -> Result<(), AdkError>

Switch to frame by selector.

pub async fn switch_to_parent_frame(&self) -> Result<(), AdkError>

Switch to parent frame.

pub async fn switch_to_default_content(&self) -> Result<(), AdkError>

Switch to default content.

pub async fn drag_and_drop( &self, source_selector: &str, target_selector: &str, ) -> Result<(), AdkError>

Drag and drop.

pub async fn right_click(&self, selector: &str) -> Result<(), AdkError>

Right-click (context click).

pub async fn focus_element(&self, selector: &str) -> Result<(), AdkError>

Focus an element.

pub async fn get_element_state( &self, selector: &str, ) -> Result<ElementState, AdkError>

Get element state.

pub async fn press_key( &self, key: &str, selector: Option<&str>, modifiers: &[&str], ) -> Result<(), AdkError>

Press a key, optionally with modifier keys (Ctrl, Alt, Shift, Meta).

pub async fn upload_file( &self, selector: &str, file_path: &str, ) -> Result<(), AdkError>

Upload a file.

pub async fn print_to_pdf( &self, landscape: bool, scale: f64, ) -> Result<String, AdkError>

Print page to PDF.

Trait Implementations

impl Drop for BrowserSession

fn drop(&mut self)

Executes the destructor for this type.