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 (dotnet) #15477

Merged
merged 1 commit into from
Mar 22, 2025

Conversation

selenium-ci
Copy link
Member

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

User description

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


PR Type

Documentation


Description

  • Updated API documentation for Selenium .NET bindings to version 4.30.0.

  • Added new methods and properties, such as OnNavigationCommittedAsync, SetCacheBehaviorAsync, and PromptUnload.

  • Enhanced documentation with nullable type annotations, exception details, and refined descriptions.

  • Fixed typos and improved parameter and method descriptions across multiple classes and modules.

  • Updated source code line references and adjusted links to reflect changes in the codebase.

  • Removed deprecated method references and reorganized class references in the BiDi Script module.

  • Deleted outdated documentation files for older versions of DevTools and other modules.


Changes walkthrough 📝

Relevant files
Documentation
12 files
OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html
Update references and add navigation event methods.           

docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextModule.html

  • Updated source code line references for multiple methods and
    constructors.
  • Added new methods OnNavigationCommittedAsync with overloads for
    handling navigation events.
  • Adjusted links to reflect updated line numbers in the source code.
  • +113/-37
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html
    Update references and add navigation event methods.           

    docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContext.html

  • Updated source code line references for properties and methods.
  • Added new methods OnNavigationCommittedAsync with overloads for
    navigation events.
  • Adjusted links to reflect updated line numbers in the source code.
  • +113/-37
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextNetworkModule.html
    Update references and add cache behavior method.                 

    docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextNetworkModule.html

  • Updated source code line references for methods and constructors.
  • Added new method SetCacheBehaviorAsync for configuring cache behavior.
  • Adjusted links to reflect updated line numbers in the source code.
  • +54/-16 
    OpenQA.Selenium.Chromium.ChromiumOptions.html
    Updated ChromiumOptions documentation with nullable types and
    exceptions.

    docs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumOptions.html

  • Added new method references and updated existing ones with nullable
    types.
  • Adjusted source code line references for various properties and
    methods.
  • Included new exception documentation for several methods.
  • Updated property types to nullable where applicable.
  • +166/-42
    OpenQA.Selenium.Chromium.ChromiumDriver.html
    Enhanced ChromiumDriver documentation with nullable types and
    exceptions.

    docs/api/dotnet/webdriver/OpenQA.Selenium.Chromium.ChromiumDriver.html

  • Adjusted source code line references for fields, properties, and
    methods.
  • Added exception documentation for constructors and methods.
  • Updated method return types and parameters to nullable where
    applicable.
  • Removed a deprecated method reference.
  • +72/-42 
    OpenQA.Selenium.BiDi.Modules.Script.html
    Expanded BiDi Script module documentation with new classes.

    docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.Script.html

  • Reorganized and added new class references for BiDi Script module.
  • Updated links to reflect new or renamed classes and interfaces.
  • Added new entries for various value types and realm information.
  • +89/-81 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CloseOptions.html
    Added PromptUnload property to CloseOptions documentation.

    docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.BrowsingContext.CloseOptions.html

  • Added a new property PromptUnload with nullable boolean type.
  • Updated source code line reference for the class.
  • +37/-2   
    OpenQA.Selenium.By.html
    Updated API documentation for By class with corrections and
    enhancements.

    docs/api/dotnet/webdriver/OpenQA.Selenium.By.html

  • Updated source code line references in documentation links.
  • Fixed typos in descriptions (e.g., "critieria" to "criteria").
  • Added nullable annotations for certain properties and methods.
  • Enhanced exception documentation for methods.
  • +88/-34 
    OpenQA.Selenium.DevTools.DevToolsSession.html
    Enhanced DevToolsSession documentation with fixes and nullable
    annotations.

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.DevToolsSession.html

  • Corrected typos in descriptions (e.g., "recieve" to "receive").
  • Updated source code line references in documentation links.
  • Added nullable annotations for properties and methods.
  • Improved exception documentation for constructors and methods.
  • +62/-31 
    OpenQA.Selenium.DevTools.Network.html
    Improved Network class documentation with fixes and detailed
    exceptions.

    docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.Network.html

  • Updated source code line references in documentation links.
  • Fixed typos in method descriptions (e.g., "diables" to "disables").
  • Added nullable annotations for method parameters.
  • Expanded exception documentation for methods.
  • +69/-34 
    OpenQA.Selenium.CapabilityType.html
    Refined CapabilityType documentation with updates and nullable
    annotations.

    docs/api/dotnet/webdriver/OpenQA.Selenium.CapabilityType.html

  • Updated source code line references in documentation links.
  • Added nullable annotations to method parameters.
  • Enhanced descriptions for fields and methods.
  • +33/-33 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextLogModule.html
    Updated BrowsingContextLogModule documentation with corrections and
    refinements.

    docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextLogModule.html

  • Updated source code line references in documentation links.
  • Changed references from Entry to LogEntry in method signatures and
    descriptions.
  • Improved parameter descriptions for methods.
  • +13/-13 
    Additional files
    101 files
    index.json [link]   
    manifest.json [link]   
    OpenQA.Selenium.Support.Events.EventFiringWebDriver.html +3/-3     
    OpenQA.Selenium.BiDi.BiDi.html +43/-12 
    OpenQA.Selenium.BiDi.BiDiException.html +3/-3     
    OpenQA.Selenium.BiDi.BrowsingContextEventArgs.html +4/-4     
    OpenQA.Selenium.BiDi.Communication.Broker.html +60/-20 
    OpenQA.Selenium.BiDi.Communication.Command.html +73/-45 
    OpenQA.Selenium.BiDi.Communication.CommandOptions.html +8/-3     
    OpenQA.Selenium.BiDi.Communication.EventHandler.html +7/-7     
    OpenQA.Selenium.BiDi.EventArgs.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.Browser.BrowserModule.html +43/-7   
    OpenQA.Selenium.BiDi.Modules.Browser.ClientWindow.html +182/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.ClientWindowInfo.html +451/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.ClientWindowState.html +155/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.CloseOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Browser.CreateUserContextOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Browser.GetClientWindowsOptions.html +187/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.GetClientWindowsResult.html +292/-0 
    OpenQA.Selenium.BiDi.Modules.Browser.GetUserContextsOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Browser.GetUserContextsResult.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.Browser.RemoveUserContextOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Browser.UserContext.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.Browser.UserContextInfo.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Browser.html +23/-0   
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.AccessibilityLocatorValue.html +248/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.AccessibilityLocator.html +254/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ActivateOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BoxClipRectangle.html +353/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextGetTreeOptions.html +3/-3     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextInfo.html +44/-11 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextInputModule.html +45/-5   
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextScriptModule.html +9/-9     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextStorageModule.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.ScreenshotOrigin.html +151/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotOptions.html +7/-7     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CaptureScreenshotResult.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ClipRectangle.Box.html +0/-353 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ClipRectangle.Element.html +0/-255 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ClipRectangle.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextLocator.ContextLocatorValue.html +252/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextLocator.html +254/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ContextType.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CreateOptions.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CreateResult.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CssLocator.html +254/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ElementClipRectangle.html +255/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.GetTreeOptions.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.GetTreeResult.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.HandleUserPromptOptions.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ImageFormat.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.Match.html +151/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.InnerTextLocator.html +347/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.LocateNodesOptions.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.LocateNodesResult.html +13/-13 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.Accessibility.AccessibilityValue.html +0/-248 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.Accessibility.html +0/-254 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.Css.html +0/-254 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.InnerText.html +0/-347 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.XPath.html +0/-254 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Locator.html +12/-10 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.MatchType.html +0/-151 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigateOptions.html +3/-3     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigateResult.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Navigation.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.NavigationInfo.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Origin.html +0/-151 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintMargin.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintOptions.html +9/-9     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintOrientation.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintPage.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintPageRange.html +6/-6     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.PrintResult.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ReadinessState.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.ReloadOptions.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.SetViewportOptions.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.TraverseHistoryOptions.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.TraverseHistoryResult.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptClosedEventArgs.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptOpenedEventArgs.html +42/-9   
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.UserPromptType.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.Viewport.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.XPathLocator.html +254/-0 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.html +31/-23 
    OpenQA.Selenium.BiDi.Modules.Input.DownKey.html +256/-0 
    OpenQA.Selenium.BiDi.Modules.Input.DownPointer.html +474/-0 
    OpenQA.Selenium.BiDi.Modules.Input.ElementOrigin.html +254/-0 
    OpenQA.Selenium.BiDi.Modules.Input.IKeySourceAction.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Input.INoneSourceAction.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Input.IPointerCommonProperties.html +9/-9     
    OpenQA.Selenium.BiDi.Modules.Input.IPointerSourceAction.html +5/-5     
    OpenQA.Selenium.BiDi.Modules.Input.ISourceAction.html +2/-2     
    OpenQA.Selenium.BiDi.Modules.Input.IWheelSourceAction.html +3/-3     
    OpenQA.Selenium.BiDi.Modules.Input.InputModule.html +47/-5   
    OpenQA.Selenium.BiDi.Modules.Input.Key.Down.html +0/-256 
    OpenQA.Selenium.BiDi.Modules.Input.Key.Up.html +0/-256 
    OpenQA.Selenium.BiDi.Modules.Input.Key.html +4/-4     
    OpenQA.Selenium.BiDi.Modules.Input.KeyActions.html +3/-3     
    OpenQA.Selenium.BiDi.Modules.Input.MovePointer.html +569/-0 
    OpenQA.Selenium.BiDi.Modules.Input.None.html +2/-2     
    Additional files not shown

    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.

    @nvborisenko
    Copy link
    Member

    Oh, I spent only 2 days to review it. I am superman! I would request changes, but recall you are not superman :)

    @nvborisenko nvborisenko merged commit 67dbcbf into gh-pages Mar 22, 2025
    1 check passed
    @nvborisenko nvborisenko deleted the api-docs-4.30.0-dotnet branch March 22, 2025 19:08
    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.

    2 participants