-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
Update documentation for Selenium 4.35.0-all #16183
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
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
||||||||||||||||||
User description
This PR updates the API documentation for version 4.35.0-all.
PR Type
Documentation
Description
• Updated API documentation for Selenium .NET WebDriver version 4.35.0
• Enhanced BiDi (Browser Bidirectional) API with new network interception methods and standardized return types
• Added new
ChromiumDriverLogLevelenum and logging enhancements for Chromium-based drivers• Introduced
BiDiOptionsclass for BiDi configuration• Removed deprecated methods and constructors across DevTools and driver classes
• Updated DevTools version support (removed V130-V136, added V139)
• Fixed various documentation typos and updated source code line references
• Cleaned up obsolete API elements and standardized async method return types
Diagram Walkthrough
File Walkthrough
10 files
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContext.html
Update BrowsingContext API documentation with new return typesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContext.html
• Updated source code line references throughout the file (line
numbers incremented by 1)
• Changed return types from
TasktoTaskforseveral async methods (
ActivateAsync,CloseAsync,HandleUserPromptAsync,SetViewportAsync)• Changed return type from
TasktoTaskforTraverseHistoryAsyncmethod• Removed two navigation
methods:
NavigateBackAsyncandNavigateForwardAsyncOpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextNetworkModule.html
Update BrowsingContextNetworkModule API documentation with new returntypesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextNetworkModule.html
• Updated source code line references throughout the file (line
numbers incremented by 1)
• Changed return type from
TasktoTaskforSetCacheBehaviorAsyncmethodOpenQA.Selenium.BiDi.Network.NetworkModule.html
Add new network interception methods to NetworkModule documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Network.NetworkModule.html
• Added several new async methods:
AddInterceptAsync,ContinueRequestAsync,ContinueResponseAsync,ContinueWithAuthAsync(multiple overloads),
FailRequestAsync,ProvideResponseAsync,RemoveInterceptAsync• Changed return type from
TasktoTaskforSetCacheBehaviorAsyncmethod• All new methods return
TaskorTasktypes
OpenQA.Selenium.DevTools.DevToolsSession.html
Remove obsolete DevToolsSession constructor from documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.DevToolsSession.html
• Removed obsolete constructor
DevToolsSession(string)that was markedwith
[Obsolete]attribute• Updated source code line references
throughout the file (line numbers decremented due to removed
constructor)
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextModule.html
Update BrowsingContextModule API documentation with new return typesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextModule.html
• Changed return types from
TasktoTaskfor several async methods:ActivateAsync,CloseAsync,HandleUserPromptAsync,SetViewportAsyncOpenQA.Selenium.BiDi.Browser.BrowserModule.html
Update BrowserModule API documentation with new return typesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Browser.BrowserModule.html
• Changed return types from
TasktoTaskforCloseAsyncandRemoveUserContextAsyncmethodsOpenQA.Selenium.DevTools.IDevTools.html
Update IDevTools interface documentation line referencedocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.IDevTools.html
• Updated source code line reference for
CloseDevToolsSessionmethod(line number changed from 66 to 56)
OpenQA.Selenium.DevTools.ConsoleApiCalledEventArgs.html
Documentation typo fixdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.ConsoleApiCalledEventArgs.html
• Fixed typo in documentation: "time stanp" corrected to "time stamp"
OpenQA.Selenium.Chromium.ChromiumOptions.html
Documentation typo fixesdocs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumOptions.html
• Fixed typo in documentation: "exeption" corrected to "exception" in
two locations
OpenQA.Selenium.DevTools.ICommandResponseExtensions.html
Documentation typo fixdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.ICommandResponseExtensions.html
• Fixed typo in documentation: "impelementing" corrected to
"implementing"
23 files
OpenQA.Selenium.BiDi.BiDi.html
BiDi class sealed and documentation cleanupdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BiDi.html
• Changed class declaration from
public class BiDitopublic sealedclass BiDi• Removed
object.MemberwiseClone()from inherited members•
Updated line number references in source code links throughout the
file
• Removed
DisposeAsyncCore()method from the documentationOpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextInputModule.html
Input module methods return type updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextInputModule.html
• Updated return types from
TasktoTaskforPerformActionsAsync,ReleaseActionsAsync, andSetFilesAsyncmethods• Updated source code
line number references
OpenQA.Selenium.Chromium.ChromiumDriver.html
ChromiumDriver deprecated method removal and updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumDriver.html
• Removed deprecated
GetDevToolsSession(int)method from documentation• Updated source code line number references for various methods
•
Updated extension method reference to include
BiDiOptionsparameterOpenQA.Selenium.Chromium.ChromiumDriverService.html
ChromiumDriverService logging enhancements and cleanupdocs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumDriverService.html
• Added new
LogLevelproperty of typeChromiumDriverLogLevel• Added
new
ReadableTimestampboolean property• Removed deprecated
WhitelistedIPAddressesproperty• Added
OnDriverProcessDataReceivedmethod to inherited members
OpenQA.Selenium.Chromium.ChromiumDriverLogLevel.html
New ChromiumDriverLogLevel enum documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumDriverLogLevel.html
• New enum file defining logging levels for Chromium-based drivers
•
Includes values: All, Debug, Info, Warning, Severe, Off, Default
OpenQA.Selenium.BiDi.BiDiOptions.html
New BiDiOptions class documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BiDiOptions.html
• New class file for
BiDiOptionssealed class• Basic class structure
with standard object inheritance
OpenQA.Selenium.BiDi.Communication.Broker.html
Broker communication method cleanupdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Communication.Broker.html
• Removed
ExecuteCommandAsyncmethod overload that returnedTask•
Updated source code line number references for remaining methods
OpenQA.Selenium.BiDi.Input.InputModule.html
Input module return type standardizationdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Input.InputModule.html
• Updated return types from
TasktoTaskforPerformActionsAsync,ReleaseActionsAsync, andSetFilesAsyncmethodsOpenQA.Selenium.DevTools.UserAgent.html
UserAgent deprecated constructor removaldocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.UserAgent.html
• Removed deprecated parameterless constructor
UserAgent()• Updated
source code line number references for remaining constructor and
properties
OpenQA.Selenium.BiDi.WebDriverExtensions.html
WebDriver extension method parameter enhancementdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.WebDriverExtensions.html
• Updated
AsBiDiAsyncmethod signature to include optionalBiDiOptionsparameter
• Method now accepts
AsBiDiAsync(IWebDriver, BiDiOptions?)instead of just
AsBiDiAsync(IWebDriver)OpenQA.Selenium.BiDi.Browser.CreateUserContextOptions.html
Browser context options enhancementdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Browser.CreateUserContextOptions.html
• Added new
UnhandledPromptBehaviorproperty of typeUserPromptHandlerOpenQA.Selenium.Chrome.ChromeDriver.html
ChromeDriver deprecated method removaldocs/api/dotnet/webdriver/OpenQA.Selenium.Chrome.ChromeDriver.html
• Removed deprecated
GetDevToolsSession(int)method from inheritedmembers
• Updated extension method reference to include
BiDiOptionsparameter
OpenQA.Selenium.Chrome.ChromeDriverService.html
ChromeDriverService inherited members updatedocs/api/dotnet/webdriver/OpenQA.Selenium.Chrome.ChromeDriverService.html
• Added new
LogLevelandReadableTimestampproperties to inheritedmembers
• Removed deprecated
WhitelistedIPAddressespropertyOpenQA.Selenium.BiDi.Script.ScriptModule.html
Script module return type updatedocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Script.ScriptModule.html
• Updated
RemovePreloadScriptAsyncmethod return type fromTasktoTaskOpenQA.Selenium.DevTools.DevToolsSessionDomains.html
DevTools version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.DevToolsSessionDomains.html
• Updated derived classes list: removed V135 and V136, added V139
OpenQA.Selenium.DevTools.JavaScript.html
DevTools JavaScript version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.JavaScript.html
• Updated derived classes list: removed V136, added V139
OpenQA.Selenium.DevTools.DevToolsDomains.html
DevTools domains version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.DevToolsDomains.html
• Updated derived classes list: removed V136, added V139
OpenQA.Selenium.DevTools.Log.html
DevTools Log version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.Log.html
• Updated derived classes list: removed V136, added V139
OpenQA.Selenium.DevTools.Network.html
DevTools Network version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.Network.html
• Updated derived classes list: removed V136, added V139
OpenQA.Selenium.DevTools.Target.html
DevTools Target version updatesdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.Target.html
• Updated derived classes list: removed V136, added V139
OpenQA.Selenium.Chromium.html
Chromium namespace enum additiondocs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.html
• Added new
ChromiumDriverLogLevelenum to the enums sectionOpenQA.Selenium.BiDi.Network.SameSite.html
SameSite enum value additiondocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Network.SameSite.html
• Added new
Default = 3enum value to the SameSite enumOpenQA.Selenium.BiDi.html
BiDi namespace class additiondocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.html
• Added
BiDiOptionsclass to the classes section3 files
OpenQA.Selenium.BiDi.BrowsingContext.InterceptAuthOptions.html
Minor line number reference updatedocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.InterceptAuthOptions.html
• Updated source code line number reference from line 141 to 142
OpenQA.Selenium.BiDi.BrowsingContext.InterceptRequestOptions.html
Minor line number reference updatedocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.InterceptRequestOptions.html
• Updated source code line number reference from line 137 to 138
OpenQA.Selenium.BiDi.BrowsingContext.InterceptResponseOptions.html
Minor line number reference updatedocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.InterceptResponseOptions.html
• Updated source code line number reference from line 139 to 140
101 files