Skip to content

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 annotations for improved null safety.

  • Fixed typos and improved exception handling details across multiple classes.

  • Reorganized and expanded class references in the Script module.

  • Removed outdated method references and adjusted method signatures for consistency.

  • Deleted obsolete files related to older DevTools versions.


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 existing methods and
    constructors.
  • Added new methods OnNavigationCommittedAsync with overloads for
    handling navigation events.
  • +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 existing methods and
    properties.
  • Added new methods OnNavigationCommittedAsync with overloads for
    handling navigation events.
  • +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 existing methods and
    constructors.
  • Added new method SetCacheBehaviorAsync for configuring cache behavior.
  • +54/-16 
    OpenQA.Selenium.Chromium.ChromiumOptions.html
    Update ChromiumOptions documentation with nullable types and
    exceptions.

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

  • Added new method references and updated links to source code.
  • Updated property types to nullable types (e.g.,
    ChromiumAndroidOptions?).
  • Added new exception handling details for various methods and
    properties.
  • Adjusted line references for updated source code.
  • +166/-42
    OpenQA.Selenium.Chromium.ChromiumDriver.html
    Enhance ChromiumDriver documentation with exceptions and updates.

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

  • Updated source code links for methods and properties.
  • Added exception details for constructors and methods.
  • Adjusted method signatures to include nullable types.
  • Removed outdated method references.
  • +72/-42 
    OpenQA.Selenium.BiDi.Modules.Script.html
    Expand and reorganize Script module class references.       

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

  • Added new class references and updated existing ones.
  • Reorganized and expanded the list of classes and interfaces.
  • Updated links to reflect new source code structure.
  • +89/-81 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.CloseOptions.html
    Add 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 link for the class.
  • +37/-2   
    OpenQA.Selenium.By.html
    Documentation updates for `By` class in Selenium .NET API.

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

  • Updated source code line references for constructors, properties, and
    methods.
  • Fixed typos in descriptions such as "critieria" to "criteria" and
    "elemsnts" to "elements".
  • Added nullable annotations (?) to several properties and methods for
    better null safety.
  • Included additional exception documentation for methods like
    ClassName, CssSelector, and XPath.
  • +88/-34 
    OpenQA.Selenium.DevTools.DevToolsSession.html
    Documentation improvements for DevToolsSession class in Selenium .NET
    API.

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

  • Corrected typos in descriptions, e.g., "recieve" to "receive".
  • Updated source code line references for constructors, properties, and
    methods.
  • Added nullable annotations (?) to properties, methods, and events for
    null safety.
  • Enhanced exception documentation for methods like SendCommand and
    GetVersionSpecificDomains.
  • +62/-31 
    OpenQA.Selenium.DevTools.Network.html
    Documentation updates for `Network` class in Selenium .NET API.

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

  • Updated source code line references for methods and events.
  • Fixed typos in descriptions, e.g., "diables" to "disables".
  • Added nullable annotations (?) to method parameters for null safety.
  • Included additional exception documentation for methods like
    AddResponseBody and ContinueRequest.
  • +69/-34 
    OpenQA.Selenium.CapabilityType.html
    Documentation enhancements for CapabilityType class in Selenium .NET
    API.

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

  • Updated source code line references for fields and methods.
  • Added nullable annotations (?) to method parameters for null safety.
  • Adjusted method signature for IsSpecCompliantCapabilityName to accept
    nullable strings.
  • +33/-33 
    OpenQA.Selenium.BiDi.Modules.BrowsingContext.BrowsingContextLogModule.html
    Documentation updates for BrowsingContextLogModule class in Selenium
    .NET API.

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

  • Updated source code line references for constructors and methods.
  • Renamed Entry to LogEntry in method signatures for consistency.
  • Adjusted method parameters to reflect updated types and nullable
    annotations.
  • +13/-13 
    Additional files
    101 files
    bazel-bin +1/-0     
    bazel-out +1/-0     
    bazel-selenium +1/-0     
    bazel-testlogs +1/-0     
    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 
    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.
  • @titusfortner
    Copy link
    Member

    Ah, I see what is going on. closing

    @qodo-merge-pro
    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

    @qodo-merge-pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner titusfortner added B-docs API Docs; see other repo for website documentation and removed documentation labels Mar 30, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    B-docs API Docs; see other repo for website documentation Review effort 1/5

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants