Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Selenium 4.30.0 (java) #15478

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from

Conversation

selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Mar 21, 2025

User description

This PR updates the API documentation for java language bindings to version 4.30.0.


PR Type

Documentation, Enhancement


Description

  • Updated the Java API documentation to version 4.30.0.

  • Added new classes, enums, and methods, including ClientWindowState, PermissionState, and ClientWindowInfo.

  • Introduced new packages such as bidi.browser and bidi.permissions.

  • Updated and reorganized constants, method signatures, and package hierarchies.

  • Removed deprecated elements and cleaned up the deprecated list.

  • Enhanced documentation for LocalNode, ChromiumDriver, and FirefoxDriver with new methods and adjustments.


Changes walkthrough 📝

Relevant files
Documentation
11 files
type-search-index.js
Update type search index with new classes and interfaces.

docs/api/java/type-search-index.js

  • Updated the typeSearchIndex array to include new entries.
  • Added new classes and interfaces related to bidi.browser and
    bidi.permissions.
  • Updated the updateSearchResults function call.
  • +1/-1     
    package-search-index.js
    Add new packages to package search index.                               

    docs/api/java/package-search-index.js

  • Updated the packageSearchIndex array to include new packages.
  • Added org.openqa.selenium.bidi.browser and
    org.openqa.selenium.bidi.permissions packages.
  • Updated the updateSearchResults function call.
  • +1/-1     
    DriverCommand.html
    Update DriverCommand field summary with new commands.       

    docs/api/java/org/openqa/selenium/remote/DriverCommand.html

  • Modified the Field Summary section to update and reorder commands.
  • Added new commands like GET_PAGE_SOURCE, GET_SESSION_STORAGE_ITEM, and
    others.
  • Removed some older commands and replaced them with updated ones.
  • +34/-68 
    ExecuteMethod.html
    Update ExecuteMethod usage references in documentation.   

    docs/api/java/org/openqa/selenium/remote/class-use/ExecuteMethod.html

  • Updated the Uses of Interface section to reflect changes in package
    usage.
  • Removed org.openqa.selenium.remote.mobile and added
    org.openqa.selenium.safari.
  • +1/-19   
    element-list
    Add new elements to the element list.                                       

    docs/api/java/element-list

  • Added new entries for org.openqa.selenium.bidi.browser and
    org.openqa.selenium.bidi.permissions.
  • Updated the list to reflect new elements introduced in the API.
  • +2/-2     
    constant-values.html
    Update and reorganize constants in Java API documentation.

    docs/api/java/constant-values.html

  • Added new constant DEFAULT_PURGE_NODES_INTERVAL with a value of 30.
  • Reorganized and reintroduced several constants related to
    DriverCommand.
  • Removed some deprecated or unused constants from the documentation.
  • +108/-111
    ChromiumDriver.html
    Refactor ChromiumDriver documentation to remove deprecated elements.

    docs/api/java/org/openqa/selenium/chromium/ChromiumDriver.html

  • Removed references to deprecated NetworkConnection interface and
    related methods.
  • Adjusted method summaries and deprecated labels for clarity.
  • Updated interface implementations for ChromiumDriver.
  • +42/-92 
    overview-tree.html
    Update package and class hierarchy in overview documentation.

    docs/api/java/overview-tree.html

  • Added new packages: bidi.browser and bidi.permissions.
  • Removed references to deprecated mobile and remote.mobile packages.
  • Introduced new classes and enums in the hierarchy, such as
    ClientWindow and PermissionState.
  • +10/-7   
    FirefoxDriver.html
    Refactor FirefoxDriver documentation to remove deprecated elements.

    docs/api/java/org/openqa/selenium/firefox/FirefoxDriver.html

  • Removed references to deprecated DevTools methods.
  • Updated method summaries and deprecated labels for clarity.
  • Adjusted interface implementations for FirefoxDriver.
  • +19/-61 
    package-tree.html
    Introduce new Permission class in bidi.module package.     

    docs/api/java/org/openqa/selenium/bidi/module/package-tree.html

  • Added new class Permission to the bidi.module package hierarchy.
  • +1/-0     
    deprecated-list.html
    Clean up deprecated list for removed functionalities.       

    docs/api/java/deprecated-list.html

  • Removed deprecated entries related to NetworkConnection and
    RemoteNetworkConnection.
  • Updated deprecated methods list to reflect the removal of unsupported
    functionalities.
  • +7/-29   
    Enhancement
    5 files
    LocalNode.html
    Update method signatures and add new methods for LocalNode.

    docs/api/java/org/openqa/selenium/grid/node/local/LocalNode.html

  • Updated method signatures to replace UUID with SessionId in several
    methods.
  • Added new methods such as getExternalUri, getGridUri, getHealthCheck,
    and getLoad.
  • Introduced new methods for session and node management, including
    getNodeId, getSession, and getStatus.
  • Removed deprecated methods like getDownloadsIdForSession.
  • +39/-48 
    ClientWindowState.html
    Introduce ClientWindowState enum for browser states.         

    docs/api/java/org/openqa/selenium/bidi/browser/ClientWindowState.html

  • Added a new enum class ClientWindowState with constants like
    FULLSCREEN, MAXIMIZED, MINIMIZED, and NORMAL.
  • Included methods like values, valueOf, toString, and fromString for
    enum handling.
  • +256/-0 
    PermissionState.html
    Introduce PermissionState enum for permission handling.   

    docs/api/java/org/openqa/selenium/bidi/permissions/PermissionState.html

  • Added a new enum class PermissionState with constants DENIED, GRANTED,
    and PROMPT.
  • Included methods like values, valueOf, toString, and findByName for
    enum handling.
  • +248/-0 
    ClientWindowInfo.html
    Add ClientWindowInfo class for browser window details.     

    docs/api/java/org/openqa/selenium/bidi/browser/ClientWindowInfo.html

  • Added a new class ClientWindowInfo with attributes like clientWindow,
    state, width, height, x, y, and active.
  • Included methods for accessing these attributes and a static method
    fromJson for JSON deserialization.
  • +234/-0 
    Permission.html
    Replace RemoteNetworkConnection with Permission class.     

    docs/api/java/org/openqa/selenium/bidi/module/Permission.html

  • Replaced the deprecated RemoteNetworkConnection class with the new
    Permission class.
  • Added methods setPermission to manage permissions with parameters like
    permissionDescriptor, state, origin, and userContext.
  • Updated constructor to use WebDriver instead of ExecuteMethod.
  • +37/-77 
    Additional files
    76 files
    allclasses-index.html +436/-434
    allpackages-index.html +20/-20 
    index-all.html +140/-137
    index.html +20/-20 
    member-search-index.js +1/-1     
    ClientWindow.html +159/-0 
    ClientWindow.html +5/-5     
    ClientWindowInfo.html +99/-0   
    ClientWindowState.html +112/-0 
    package-summary.html +23/-23 
    package-tree.html +87/-0   
    package-use.html +95/-0   
    package-summary.html +0/-10   
    package-summary.html +0/-10   
    Browser.html +13/-4   
    Network.html +20/-0   
    Permission.html +58/-0   
    package-summary.html +4/-12   
    CacheBehavior.html +231/-0 
    CacheBehavior.html +111/-0 
    package-summary.html +22/-30 
    package-tree.html +1/-0     
    package-use.html +24/-20 
    package-summary.html +8/-4     
    PermissionState.html +118/-0 
    package-summary.html +8/-10   
    package-tree.html +9/-5     
    package-use.html +39/-4   
    package-summary.html +0/-10   
    package-summary.html +0/-10   
    ChromeDriver.html +2/-5     
    package-tree.html +1/-1     
    package-tree.html +1/-1     
    Capabilities.html +4/-2     
    WebDriver.html +8/-5     
    HasDevTools.html +1/-1     
    DevTools.html +0/-33   
    HasDevTools.html +0/-18   
    package-use.html +0/-15   
    Device.html +2/-1     
    Docker.html +2/-1     
    Image.html +2/-1     
    EdgeDriver.html +2/-5     
    package-tree.html +1/-1     
    EventBus.html +3/-2     
    package-tree.html +1/-1     
    ConfigValue.html +12/-6   
    SlotMatcher.html +3/-2     
    DistributorFlags.html +9/-0     
    DistributorOptions.html +34/-8   
    LocalDistributor.html +6/-4     
    SlotSelector.html +3/-2     
    Node.html +3/-3     
    NodeFlags.html +15/-6   
    NodeOptions.html +22/-13 
    DockerSessionFactory.html +4/-2     
    DockerAssetsPath.html +2/-1     
    RemoteNode.html +1/-1     
    Secret.html +3/-2     
    SessionMap.html +3/-2     
    NewSessionQueue.html +3/-2     
    TemporaryFilesystem.html +2/-2     
    NetworkConnection.ConnectionType.html +0/-319 
    NetworkConnection.html +0/-193 
    NetworkConnection.ConnectionType.html +0/-195 
    NetworkConnection.html +0/-141 
    package-tree.html +0/-78   
    package-use.html +0/-153 
    PageSize.html +84/-6   
    PageSize.html +26/-2   
    RemoteWebDriver.html +3/-3     
    SessionId.html +19/-16 
    HttpClient.Factory.html +5/-3     
    package-summary.html +2/-4     
    package-use.html +2/-17   
    Tracer.html +5/-3     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner titusfortner requested review from diemol and pujagani March 21, 2025 23:51
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant