功能和 EdgeOptions

功能是可用于自定义和配置 EdgeDriver 会话的选项。 若要了解如何启动新 EdgeDriver 会话,请参阅 自动化 Microsoft Edge。 本文介绍 Microsoft Edge 支持的所有功能,并提供有关将功能传递给 EdgeDriver 会话的详细信息。

功能以 JSON 映射的形式传递给 WebDriver 会话,但没有必要或建议以这种方式设置这些功能。 WebDriver 测试框架 ((如 Selenium) )提供通常具有便捷方法的语言绑定,因此无需自行配置 JSON 映射。 例如,Selenium 通过 EdgeOptions 类配置功能。

若要详细了解如何配置功能,请参阅首选 WebDriver 测试框架的文档。 有关详细信息,请参阅 选择 WebDriver 测试框架

使用 EdgeOptions 类

创建 的 EdgeOptions实例,该实例提供了设置特定于 Microsoft Edge 的功能的便捷方法。 配置 EdgeOptions 对象后,传入 EdgeOptions 构造 EdgeDriver 函数。

var options = new EdgeOptions();
options.AddExtensions("/path/to/extension.crx");
var driver = new EdgeDriver(options);

若要使用没有关联便利方法的功能,请使用 AddAdditionalEdgeOption 方法。 必须传递功能的完整名称和类型正确的值。 有关接受的功能和值类型的完整列表,请参阅 EdgeOptions 对象

options.AddAdditionalEdgeOption("wdpAddress", "remotehost:50080");

识别的功能

有关接受的标准功能 EdgeDriver ,请参阅 Selenium 文档W3C WebDriver 标准。 本文仅列出了特定于 Microsoft Edge 的功能。

EdgeOptions 对象

大多数特定于 Microsoft Edge 的功能都通过 EdgeOptions 对象公开。 在某些语言中,这些功能由 EdgeOptions 类实现。 在其他语言中,这些功能存储在 中的字典下ms:edgeOptionsDesiredCapabilities

功能 类型 详细信息
args 字符串列表 在启动时传递给 Microsoft Edge 进程的命令行参数列表。 具有关联值的参数应用 = 符号分隔 (例如 ['start-maximized', 'user-data-dir=/tmp/temp_profile'] ,) 。 如果要启动 WebView2 应用,则这些参数将传递给你的应用,而不是基础 Microsoft Edge 浏览器进程。 若要在启动 WebView2 应用时将参数传递给浏览器进程,请改用 webviewOptions.additionalBrowserArguments
binary string 在 macOS 上使用 (的 Microsoft Edge 二进制文件的路径,路径应是实际的二进制文件,而不仅仅是应用。例如, /Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge) 。
debuggerAddress string 要连接到的调试器服务器的地址,格式 hostname/ip:port为 ,例如 127.0.0.1:38947
detach boolean 默认值 = false。 如果 false为 ,则即使 WebDriver 本地端尚未关闭会话,Microsoft Edge 也会在 WebDriver 服务关闭时退出。 如果 true为 ,则仅当 WebDriver 本地端关闭会话时,Microsoft Edge 才会退出。 如果 true为 ,并且 WebDriver 本地端未关闭会话, EdgeDriver 则不会清理 Microsoft Edge 实例使用的临时用户数据文件夹。
excludeSwitches 字符串列表 Microsoft Edge 命令行开关列表,用于在启动 Microsoft Edge 时排除 EdgeDriver 默认传递。 避免使用开关的 -- 前缀。
extensions 字符串列表 启动时要安装的扩展的列表。 列表中的每一项都应是 base-64 编码的打包扩展 (.crx) 。
localState 字典 包含首选项名称和值的每个条目的字典。 首选项将应用于用户数据文件夹中的“本地状态”文件。
minidumpPath string 用于存储 Microsoft Edge minidumps 的目录。 (仅在 Linux.) 上受支持
mobileEmulation 字典 一个字典,其值为 deviceName, 或 为 和 userAgent的值deviceMetrics
perfLoggingPrefs 字典 指定性能日志记录首选项的可选字典。 有关详细信息,请参阅 perfLoggingPrefs 对象
prefs 字典 包含首选项名称和值的每个条目的字典。 首选项仅应用于正在使用的用户配置文件。 有关示例,请参阅 Preferences Microsoft Edge 的用户数据文件夹中的文件。
wdpAddress string 要连接到的 Windows 设备门户服务器的地址,格式 hostname/ip:port为 ,例如 127.0.0.1:50080。 有关详细信息,请参阅远程调试 - Windows 10设备
wdpPassword string 连接到 Windows 设备门户服务器时要使用的可选密码。 如果服务器已启用身份验证,则为必需。
wdpUsername string 连接到 Windows 设备门户服务器时要使用的可选用户名。 如果服务器已启用身份验证,则为必需。
wdpProcessId integer 附加到正在运行的 WebView2 UWP 应用时要使用的必需进程 ID,例如 36590。 可以在 中找到browserProcessIdhttp://<Device Portal URL>/msedge此信息。
webviewOptions 字典 一个可选字典,可用于在启动 WebView2 应用时配置 WebView2 环境。 有关详细信息,请参阅 webviewOptions 对象
windowsApp string 要启动的 Microsoft Edge 应用包的应用程序用户模型 ID,例如 Microsoft.MicrosoftEdge.Stable_8wekyb3d8bbwe!MSEDGE。 在使用 Windows 设备门户连接到Windows 10X设备或模拟器时,请使用 windowsApp 而不是 binary
windowTypes 字符串列表 窗口句柄列表中显示的窗口类型列表。 若要访问 Android Webview 元素,请包含在 webview 列表中。

perfLoggingPrefs 对象

字典 perfLoggingPrefs 采用以下格式。 所有键都是可选的。

类型 默认值 详细信息
bufferUsageReportingInterval 正整数 1000 DevTools 跟踪缓冲区使用事件之间的请求毫秒数。 例如,如果为 1000,则每秒一次,DevTools 将报告跟踪缓冲区的满量。 如果报告指示缓冲区使用率为 100%,则会发出警告。
enableNetwork boolean true 从网络域收集 (或不收集) 事件。
enablePage boolean true 从页面域收集 (或不收集) 事件。
traceCategories string (空) 应为其收集跟踪事件的 Microsoft Edge 跟踪类别的逗号分隔字符串。 未指定或空字符串禁用跟踪。

webviewOptions 对象

字典 webviewOptions 用于在启动 WebView2 应用时配置 WebView2 环境。 它采用以下格式。 所有键都是可选的。

类型 默认值 详细信息
browserExecutableFolder string (空) 包含要使用的固定版本的 WebView2 运行时的文件夹的路径。 有关将固定版本运行时分发版与 WebView2 配合使用的详细信息,请参阅 分发 WebView2 应用和 WebView2 运行时
userDataFolder string (空) WebView2 将使用的用户数据文件夹的路径。 如果未 userDataFolder 指定 ,Microsoft Edge WebDriver 将创建一个临时用户数据文件夹。 有关使用 WebView2 管理用户数据文件夹的详细信息,请参阅 管理用户数据文件夹
additionalBrowserArguments 字符串列表 WebView2 将在启动时传递给浏览器进程的命令行参数列表。 具有关联值的参数应用 = 符号分隔 (例如 ['start-maximized', 'log-level=0'] ,) 。
releaseChannelPreference string 要使用的首选 WebView2 常青运行时分发。 可以是 "stable""canary"

返回的功能

以下列表包含创建新会话时返回的所有特定于 Microsoft Edge 的功能 EdgeDriver

功能 类型 详细信息
msedge.msedgedriverVersion string EdgeDriver 的版本。
msedge.userDataDir string Microsoft Edge 实例使用的用户数据文件夹的路径。