Update documentation for Selenium 4.30.0 (java) #15478
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
, andClientWindowInfo
.Introduced new packages such as
bidi.browser
andbidi.permissions
.Updated and reorganized constants, method signatures, and package hierarchies.
Removed deprecated elements and cleaned up the deprecated list.
Enhanced documentation for
LocalNode
,ChromiumDriver
, andFirefoxDriver
with new methods and adjustments.Changes walkthrough 📝
11 files
type-search-index.js
Update type search index with new classes and interfaces.
docs/api/java/type-search-index.js
typeSearchIndex
array to include new entries.bidi.browser
andbidi.permissions
.updateSearchResults
function call.package-search-index.js
Add new packages to package search index.
docs/api/java/package-search-index.js
packageSearchIndex
array to include new packages.org.openqa.selenium.bidi.browser
andorg.openqa.selenium.bidi.permissions
packages.updateSearchResults
function call.DriverCommand.html
Update DriverCommand field summary with new commands.
docs/api/java/org/openqa/selenium/remote/DriverCommand.html
Field Summary
section to update and reorder commands.GET_PAGE_SOURCE
,GET_SESSION_STORAGE_ITEM
, andothers.
ExecuteMethod.html
Update ExecuteMethod usage references in documentation.
docs/api/java/org/openqa/selenium/remote/class-use/ExecuteMethod.html
Uses of Interface
section to reflect changes in packageusage.
org.openqa.selenium.remote.mobile
and addedorg.openqa.selenium.safari
.element-list
Add new elements to the element list.
docs/api/java/element-list
org.openqa.selenium.bidi.browser
andorg.openqa.selenium.bidi.permissions
.constant-values.html
Update and reorganize constants in Java API documentation.
docs/api/java/constant-values.html
DEFAULT_PURGE_NODES_INTERVAL
with a value of 30.DriverCommand
.ChromiumDriver.html
Refactor ChromiumDriver documentation to remove deprecated elements.
docs/api/java/org/openqa/selenium/chromium/ChromiumDriver.html
NetworkConnection
interface andrelated methods.
ChromiumDriver
.overview-tree.html
Update package and class hierarchy in overview documentation.
docs/api/java/overview-tree.html
bidi.browser
andbidi.permissions
.mobile
andremote.mobile
packages.ClientWindow
andPermissionState
.FirefoxDriver.html
Refactor FirefoxDriver documentation to remove deprecated elements.
docs/api/java/org/openqa/selenium/firefox/FirefoxDriver.html
DevTools
methods.FirefoxDriver
.package-tree.html
Introduce new Permission class in bidi.module package.
docs/api/java/org/openqa/selenium/bidi/module/package-tree.html
Permission
to thebidi.module
package hierarchy.deprecated-list.html
Clean up deprecated list for removed functionalities.
docs/api/java/deprecated-list.html
NetworkConnection
andRemoteNetworkConnection
.functionalities.
5 files
LocalNode.html
Update method signatures and add new methods for LocalNode.
docs/api/java/org/openqa/selenium/grid/node/local/LocalNode.html
UUID
withSessionId
in severalmethods.
getExternalUri
,getGridUri
,getHealthCheck
,and
getLoad
.getNodeId
,getSession
, andgetStatus
.getDownloadsIdForSession
.ClientWindowState.html
Introduce ClientWindowState enum for browser states.
docs/api/java/org/openqa/selenium/bidi/browser/ClientWindowState.html
ClientWindowState
with constants likeFULLSCREEN
,MAXIMIZED
,MINIMIZED
, andNORMAL
.values
,valueOf
,toString
, andfromString
forenum handling.
PermissionState.html
Introduce PermissionState enum for permission handling.
docs/api/java/org/openqa/selenium/bidi/permissions/PermissionState.html
PermissionState
with constantsDENIED
,GRANTED
,and
PROMPT
.values
,valueOf
,toString
, andfindByName
forenum handling.
ClientWindowInfo.html
Add ClientWindowInfo class for browser window details.
docs/api/java/org/openqa/selenium/bidi/browser/ClientWindowInfo.html
ClientWindowInfo
with attributes likeclientWindow
,state
,width
,height
,x
,y
, andactive
.fromJson
for JSON deserialization.Permission.html
Replace RemoteNetworkConnection with Permission class.
docs/api/java/org/openqa/selenium/bidi/module/Permission.html
RemoteNetworkConnection
class with the newPermission
class.setPermission
to manage permissions with parameters likepermissionDescriptor
,state
,origin
, anduserContext
.WebDriver
instead ofExecuteMethod
.76 files