BrowserContext

浏览器上下文 (BrowserContexts) 提供了一种操作多个独立浏览器会话的方式。

如果一个页面打开另一个页面，例如通过 window.open 调用，则弹出的页面将属于父页面的浏览器上下文。

Playwright 允许通过 Browser.NewContextAsync() 方法创建隔离的非持久化浏览器上下文。非持久化浏览器上下文不会将任何浏览数据写入磁盘。

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync(new() { Headless = false });
// Create a new incognito browser context
var context = await browser.NewContextAsync();
// Create a new page inside context.
var page = await context.NewPageAsync();
await page.GotoAsync("https://bing.com");
// Dispose context once it is no longer needed.
await context.CloseAsync();

方法

AddCookiesAsync

v1.9 之前添加

browserContext.AddCookiesAsync

向此浏览器上下文中添加 Cookie。此上下文中的所有页面都将安装这些 Cookie。可以通过 BrowserContext.CookiesAsync() 获取 Cookie。

用法

await context.AddCookiesAsync(new[] { cookie1, cookie2 });

参数

cookies IEnumerable<Cookie>#
- Name string
- Value string
- Url string? (可选)
  
  需要 url 或 domain 和 path。可选。
- Domain string? (可选)
  
  要使 Cookie 也适用于所有子域名，请在域名后加上一个点，例如：".example.com"。需要 url 或 domain 和 path。可选。
- Path string? (可选)
  
  需要 url 或 domain 和 path。可选。
- Expires [float]? (可选)
  
  Unix 时间（秒）。可选。
- HttpOnly bool? (可选)
  
  可选。
- Secure bool? (可选)
  
  可选。
- SameSite enum SameSiteAttribute { Strict, Lax, None }? (可选)
  
  可选。
- PartitionKey string? (可选)
  
  对于分区第三方 cookie（又称 CHIPS），为分区键。可选。

void #

AddInitScriptAsync

v1.9 之前添加

browserContext.AddInitScriptAsync

添加一个脚本，该脚本将在以下情况之一中进行评估：

每当在浏览器上下文中创建页面或导航页面时。
每当在浏览器上下文中的任何页面中附加或导航子框架时。在这种情况下，脚本在新附加的框架的上下文中进行评估。

脚本在文档创建后但在任何脚本运行之前进行评估。这对于修改 JavaScript 环境非常有用，例如，为 Math.random 设置种子。

用法

在页面加载之前覆盖 Math.random 的示例

// preload.js
Math.random = () => 42;

await Context.AddInitScriptAsync(scriptPath: "preload.js");

注意

通过 BrowserContext.AddInitScriptAsync() 和 Page.AddInitScriptAsync() 安装的多个脚本的执行顺序未定义。

参数

script string | string #

要在浏览器上下文中的所有页面中评估的脚本。

[Disposable]#

Browser

v1.9 之前添加

browserContext.Browser

获取拥有该上下文的浏览器实例。如果该上下文在正常浏览器之外创建（例如 Android 或 Electron），则返回 null。

用法

BrowserContext.Browser

Browser?#

ClearCookiesAsync

v1.9 之前添加

browserContext.ClearCookiesAsync

从上下文清除 cookie。接受可选的过滤器。

用法

await context.ClearCookiesAsync();
await context.ClearCookiesAsync(new() { Name = "session-id" });
await context.ClearCookiesAsync(new() { Domain = "my-origin.com" });
await context.ClearCookiesAsync(new() { Path = "/api/v1" });
await context.ClearCookiesAsync(new() { Name = "session-id", Domain = "my-origin.com" });

参数

options BrowserContextClearCookiesOptions? (可选)
- Domain|DomainRegex string? | Regex? (可选)新增于: v1.43#
  
  只移除具有给定域的 cookie。
- Name|NameRegex string? | Regex? (可选)新增于: v1.43#
  
  只移除具有给定名称的 cookie。
- Path|PathRegex string? | Regex? (可选)新增于: v1.43#
  
  只移除具有给定路径的 cookie。

void #

ClearPermissionsAsync

v1.9 之前添加

browserContext.ClearPermissionsAsync

清除浏览器上下文的所有权限覆盖。

用法

var context = await browser.NewContextAsync();
await context.GrantPermissionsAsync(new[] { "clipboard-read" });
// Alternatively, you can use the helper class ContextPermissions
//  to specify the permissions...
// do stuff ...
await context.ClearPermissionsAsync();

void #

CloseAsync

v1.9 之前添加

browserContext.CloseAsync

关闭浏览器上下文。所有属于该浏览器上下文的页面都将被关闭。

注意

默认的浏览器上下文不能被关闭。

用法

await BrowserContext.CloseAsync(options);

参数

options BrowserContextCloseOptions? (可选)
- Reason string? (可选)添加于：v1.40#
  
  报告给因上下文关闭而中断的操作的原因。

void #

CookiesAsync

v1.9 之前添加

browserContext.CookiesAsync

如果未指定 URL，此方法将返回所有 cookie。如果指定了 URL，则仅返回影响这些 URL 的 cookie。

用法

await BrowserContext.CookiesAsync(urls);

参数

urls string? | IEnumerable?<string> (可选)#

可选的 URL 列表。

IReadOnlyList<BrowserContextCookiesResult>#
- name string
- value string
- domain string
- path string
- expires [float]
  
  Unix 时间戳，单位为秒。
- httpOnly bool
- secure bool
- sameSite enum SameSiteAttribute { Strict, Lax, None }
- partitionKey string? (可选)

ExposeBindingAsync

v1.9 之前添加

browserContext.ExposeBindingAsync

此方法在上下文中每个页面的每个 frame 的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。

callback 函数的第一个参数包含调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。

仅限页面的版本请参阅 Page.ExposeBindingAsync()。

用法

将页面 URL 公开给上下文中所有页面的所有框架的示例

using Microsoft.Playwright;

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
var context = await browser.NewContextAsync();

await context.ExposeBindingAsync("pageURL", source => source.Page.Url);
var page = await context.NewPageAsync();
await page.SetContentAsync("<script>\n" +
"  async function onClick() {\n" +
"    document.querySelector('div').textContent = await window.pageURL();\n" +
"  }\n" +
"</script>\n" +
"<button onclick=\"onClick()\">Click me</button>\n" +
"<div></div>");
await page.GetByRole(AriaRole.Button).ClickAsync();

参数

name string #

窗口对象上函数的名称。
callback Action<BindingSource, T, [TResult]>#

将在 Playwright 上下文中调用的回调函数。

[Disposable]#

ExposeFunctionAsync

v1.9 之前添加

browserContext.ExposeFunctionAsync

此方法在上下文中每个页面的每个 frame 的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。

如果 callback 返回一个 Promise，它将被等待。

仅限页面的版本请参阅 Page.ExposeFunctionAsync()。

用法

向上下文中所有页面添加 sha256 函数的示例

using Microsoft.Playwright;
using System;
using System.Security.Cryptography;
using System.Threading.Tasks;

class BrowserContextExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
        var context = await browser.NewContextAsync();

        await context.ExposeFunctionAsync("sha256", (string input) =>
        {
            return Convert.ToBase64String(
                SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));
        });

        var page = await context.NewPageAsync();
        await page.SetContentAsync("<script>\n" +
        "  async function onClick() {\n" +
        "    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
        "  }\n" +
        "</script>\n" +
        "<button onclick=\"onClick()\">Click me</button>\n" +
        "<div></div>");

        await page.GetByRole(AriaRole.Button).ClickAsync();
        Console.WriteLine(await page.TextContentAsync("div"));
    }
}

参数

name string #

窗口对象上函数的名称。
callback Action<T, [TResult]>#

将在 Playwright 上下文中调用的回调函数。

[Disposable]#

GrantPermissionsAsync

v1.9 之前添加

browserContext.GrantPermissionsAsync

授予浏览器上下文指定的权限。如果指定了来源，则仅授予给定来源相应的权限。

用法

await BrowserContext.GrantPermissionsAsync(permissions, options);

参数

permissions IEnumerable<string>#

要授予的权限列表。

危险
不同浏览器之间，甚至相同浏览器的不同版本之间，支持的权限也不同。任何权限都可能在更新后停止工作。

以下是一些可能受某些浏览器支持的权限：
- 'accelerometer'
- 'ambient-light-sensor'
- 'background-sync'
- 'camera'
- 'clipboard-read'
- 'clipboard-write'
- 'geolocation'
- 'gyroscope'
- 'local-fonts'
- 'local-network-access'
- 'magnetometer'
- 'microphone'
- 'midi-sysex' (系统专属 midi)
- 'midi'
- 'notifications'
- 'payment-handler'
- 'storage-access'
- 'screen-wake-lock'
options BrowserContextGrantPermissionsOptions? (可选)
- Origin string? (可选)#
  
  授予权限的源 (origin)，例如 "https://example.com"。

void #

IsClosed

新增于: v1.59

browserContext.IsClosed

表明浏览器上下文正在关闭或已经关闭。

用法

BrowserContext.IsClosed

bool #

NewCDPSessionAsync

添加于：v1.11

browserContext.NewCDPSessionAsync

注意

CDP 会话仅在基于 Chromium 的浏览器上受支持。

返回新创建的会话。

用法

await BrowserContext.NewCDPSessionAsync(page);

参数

page Page | Frame #

要为其创建新会话的目标。为了向后兼容，此参数名为 page，但它可以是 Page 或 Frame 类型。

CDPSession #

NewPageAsync

v1.9 之前添加

browserContext.NewPageAsync

在浏览器上下文中创建新页面。

用法

await BrowserContext.NewPageAsync();

Page #

Pages

v1.9 之前添加

browserContext.Pages

返回上下文中所有打开的页面。

用法

BrowserContext.Pages

IReadOnlyList<Page>#

RouteAsync

v1.9 之前添加

browserContext.RouteAsync

路由提供了修改浏览器上下文中任何页面发出的网络请求的能力。一旦启用路由，每个匹配 URL 模式的请求都将暂停，除非它被继续、完成或中止。

注意

BrowserContext.RouteAsync() 不会拦截被 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker。

用法

一个简单地中止所有图片请求的处理程序示例

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync("**/*.{png,jpg,jpeg}", r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();

或者使用正则表达式模式的相同片段

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync(new Regex("(\\.png$)|(\\.jpg$)"), r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();

可以检查请求以决定路由操作。例如，模拟所有包含某些 POST 数据的请求，并保留所有其他请求不变

await page.RouteAsync("/api/**", async r =>
{
    if (r.Request.PostData.Contains("my-string"))
        await r.FulfillAsync(new() { Body = "mocked-data" });
    else
        await r.ContinueAsync();
});

当请求同时匹配页面路由（通过 Page.RouteAsync() 设置）和浏览器上下文路由时，页面路由优先。

要删除带有处理程序的路由，可以使用 BrowserContext.UnrouteAsync()。

注意

启用路由会禁用 HTTP 缓存。

参数

url string | Regex | Func<string, bool>#

用于在路由期间匹配的 Glob 模式、正则表达式或谓词。如果上下文选项中设置了 BaseURL 且提供的 URL 是不以 * 开头的字符串，则它将使用 new URL() 构造函数进行解析。
handler Action<Route>#

用于路由请求的处理函数。
options BrowserContextRouteOptions? (可选)
- Times int? (可选)新增于: v1.15#
  
  路由应该被使用多少次。默认情况下，每次都会使用。

[Disposable]#

RouteFromHARAsync

添加于：v1.23

browserContext.RouteFromHARAsync

如果指定，上下文中发出的网络请求将由 HAR 文件提供服务。阅读更多关于从 HAR 重放的信息。

Playwright 不会从 HAR 文件中服务被 Service Worker 拦截的请求。请参阅此问题。我们建议在使用请求拦截时通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker。

用法

await BrowserContext.RouteFromHARAsync(har, options);

参数

har string #

包含预录制网络数据的 HAR 文件的路径。如果 path 是相对路径，则它会相对于当前工作目录进行解析。
options BrowserContextRouteFromHAROptions? (可选)
- NotFound enum HarNotFound { Abort, Fallback }? (可选)#
  - 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
  - 如果设置为 'fallback'，则会退回到处理程序链中的下一个路由处理程序。
  默认为中止。
- Update bool? (可选)#
  
  如果指定，将使用实际的网络信息更新给定的 HAR，而不是从文件提供服务。当调用 BrowserContext.CloseAsync() 时，文件将被写入磁盘。
- UpdateContent enum RouteFromHarUpdateContentPolicy { Embed, Attach }? (可选)新增于: v1.32#
  
  可选设置以控制资源内容管理。如果指定 attach，资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定 embed，内容将内联存储在 HAR 文件中。
- UpdateMode enum HarMode { Full, Minimal }? (可选)新增于: v1.32#
  
  当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略 HAR 信息中不用于从 HAR 重放的大小、时间、页面、cookie、安全性和其他类型的信息。默认为 minimal。
- Url|UrlRegex string? | Regex? (可选)#
  
  一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。只有 URL 匹配模式的请求将从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。

void #

RouteWebSocketAsync

新增于: v1.48

browserContext.RouteWebSocketAsync

此方法允许修改浏览器上下文中任何页面进行的 WebSocket 连接。

请注意，只有在此方法调用后创建的 WebSocket 才会路由。建议在创建任何页面之前调用此方法。

用法

以下是一个简单的处理程序示例，该处理程序会拦截部分 WebSocket 消息。有关详细信息和示例，请参阅 WebSocketRoute。

await context.RouteWebSocketAsync("/ws", async ws => {
  ws.RouteSend(message => {
    if (message == "to-be-blocked")
      return;
    ws.Send(message);
  });
  await ws.ConnectAsync();
});

参数

url string | Regex | Func<string, bool>#

只有 URL 匹配此模式的 WebSocket 才会被路由。字符串模式可以是相对于 BaseURL 上下文选项的。
handler Action<WebSocketRoute>#

用于路由 WebSocket 的处理函数。

void #

RunAndWaitForConsoleMessageAsync

新增于: v1.34

browserContext.RunAndWaitForConsoleMessageAsync

执行操作并等待上下文中页面记录 ConsoleMessage。如果提供了谓词，它会将 ConsoleMessage 值传递给 predicate 函数，并等待 predicate(message) 返回真值。如果页面在触发 BrowserContext.Console 事件之前关闭，则会抛出错误。

用法

await BrowserContext.RunAndWaitForConsoleMessageAsync(action, options);

参数

action Func<Task>#

触发事件的操作。
options BrowserContextRunAndWaitForConsoleMessageOptions? (可选)
- Predicate Func<ConsoleMessage?, bool> (可选)#
  
  接收 ConsoleMessage 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传入 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 来更改。

ConsoleMessage #

WaitForConsoleMessageAsync

新增于: v1.34

browserContext.WaitForConsoleMessageAsync

用法

await BrowserContext.WaitForConsoleMessageAsync(action, options);

参数

options BrowserContextRunAndWaitForConsoleMessageOptions? (可选)
- Predicate Func<ConsoleMessage?, bool> (可选)#
  
  接收 ConsoleMessage 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传入 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 来更改。

ConsoleMessage #

RunAndWaitForPageAsync

添加于：v1.9

browserContext.RunAndWaitForPageAsync

执行操作并等待在上下文中创建新的 Page。如果提供了谓词，它会将 Page 值传递给 predicate 函数，并等待 predicate(event) 返回真值。如果上下文在新的 Page 创建之前关闭，则会抛出错误。

用法

await BrowserContext.RunAndWaitForPageAsync(action, options);

参数

action Func<Task>添加于：v1.12#

触发事件的操作。
options BrowserContextRunAndWaitForPageOptions? (可选)
- Predicate Func<Page?, bool> (可选)#
  
  接收 Page 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传入 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 来更改。

Page #

WaitForPageAsync

添加于：v1.9

browserContext.WaitForPageAsync

用法

await BrowserContext.WaitForPageAsync(action, options);

参数

options BrowserContextRunAndWaitForPageOptions? (可选)
- Predicate Func<Page?, bool> (可选)#
  
  接收 Page 对象，并在等待应解析时解析为真值。
- Timeout [float]? (可选)#
  
  等待的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传入 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 来更改。

Page #

v1.9 之前添加

browserContext.SetDefaultNavigationTimeout

此设置将更改以下方法和相关快捷方式的默认最大导航时间

注意

Page.SetDefaultNavigationTimeout() 和 Page.SetDefaultTimeout() 的优先级高于 BrowserContext.SetDefaultNavigationTimeout()。

用法

BrowserContext.SetDefaultNavigationTimeout(timeout);

参数

timeout [float]#

最大导航时间（毫秒）

SetDefaultTimeout

v1.9 之前添加

browserContext.SetDefaultTimeout

此设置将更改所有接受 timeout 选项的方法的默认最大时间。

注意

Page.SetDefaultNavigationTimeout()、Page.SetDefaultTimeout() 和 BrowserContext.SetDefaultNavigationTimeout() 的优先级高于 BrowserContext.SetDefaultTimeout()。

用法

BrowserContext.SetDefaultTimeout(timeout);

参数

timeout [float]#

最大时间（毫秒）。传入 0 禁用超时。

SetExtraHTTPHeadersAsync

v1.9 之前添加

browserContext.SetExtraHTTPHeadersAsync

额外的 HTTP 标头将随上下文中任何页面发起的每个请求一起发送。这些标头将与通过 Page.SetExtraHTTPHeadersAsync() 设置的特定于页面的额外 HTTP 标头合并。如果页面覆盖了特定标头，则将使用特定于页面的标头值，而不是浏览器上下文标头值。

注意

BrowserContext.SetExtraHTTPHeadersAsync() 不保证传出请求中标头的顺序。

用法

await BrowserContext.SetExtraHTTPHeadersAsync(headers);

参数

headers IDictionary<string, string>#

一个包含要随每个请求发送的额外 HTTP 标头的对象。所有标头值必须是字符串。

void #

SetGeolocationAsync

v1.9 之前添加

browserContext.SetGeolocationAsync

设置上下文的地理位置。传入 null 或 undefined 模拟位置不可用。

用法

await context.SetGeolocationAsync(new Geolocation()
{
    Latitude = 59.95f,
    Longitude = 30.31667f
});

注意

考虑使用 BrowserContext.GrantPermissionsAsync() 来授予浏览器上下文页面读取其地理位置的权限。

参数

geolocation Geolocation?#
- Latitude [浮点数]
  
  纬度，介于 -90 和 90 之间。
- Longitude [浮点数]
  
  经度，介于 -180 和 180 之间。
- Accuracy [浮点数]? (可选)
  
  非负精度值。默认为 0。

void #

SetOfflineAsync

v1.9 之前添加

browserContext.SetOfflineAsync

用法

await BrowserContext.SetOfflineAsync(offline);

参数

offline bool #

是否为浏览器上下文模拟离线网络。

void #

SetStorageStateAsync

新增于: v1.59

browserContext.SetStorageStateAsync

清除所有源的现有 Cookie、本地存储和 IndexedDB 条目，并设置新的存储状态。

用法

// Load storage state from a file and apply it to the context.
await context.SetStorageStateAsync("state.json");

参数

storageStatePath string #

使用给定的存储状态填充上下文。此选项可用于初始化带有通过 BrowserContext.StorageStateAsync() 获得的登录信息的上下文。指向保存存储状态的文件路径。

void #

StorageStateAsync

v1.9 之前添加

browserContext.StorageStateAsync

返回此浏览器上下文的存储状态，包含当前 cookie、本地存储快照和 IndexedDB 快照。

用法

await BrowserContext.StorageStateAsync(options);

参数

options BrowserContextStorageStateOptions? (可选)
- IndexedDB bool? (可选)添加于: v1.51#
  
  设置为 true 以在存储状态快照中包含 IndexedDB。如果您的应用程序使用 IndexedDB 存储身份验证令牌（如 Firebase Authentication），请启用此项。
- Path string? (可选)#
  
  保存存储状态的文件路径。如果 Path 是相对路径，则它会相对于当前工作目录进行解析。如果没有提供路径，仍会返回存储状态，但不会保存到磁盘。

string #

UnrouteAsync

v1.9 之前添加

browserContext.UnrouteAsync

删除使用 BrowserContext.RouteAsync() 创建的路由。当未指定 handler 时，会删除 url 的所有路由。

用法

await BrowserContext.UnrouteAsync(url, handler);

参数

url string | Regex | Func<string, bool>#

用于注册 BrowserContext.RouteAsync() 路由的 Glob 模式、正则表达式或接收 URL 的谓词。
handler Action<Route?> (可选)#

用于注册 BrowserContext.RouteAsync() 路由的可选处理函数。

void #

UnrouteAllAsync

新增于: v1.41

browserContext.UnrouteAllAsync

删除使用 BrowserContext.RouteAsync() 和 BrowserContext.RouteFromHARAsync() 创建的所有路由。

用法

await BrowserContext.UnrouteAllAsync(options);

参数

options BrowserContextUnrouteAllOptions? (可选)
- Behavior enum UnrouteBehavior { Wait, IgnoreErrors, Default }? (可选)#
  
  指定是否等待已运行的处理程序以及如果它们抛出错误该怎么做
  - 'default' - 不等待当前处理程序调用 (如果有) 完成，如果未路由的处理程序抛出错误，可能会导致未处理的错误
  - 'wait' - 等待当前处理程序调用 (如果有) 完成
  - 'ignoreErrors' - 不等待当前处理程序调用 (如果有) 完成，取消路由后处理程序抛出的所有错误都将被静默捕获

void #

属性

APIRequest

添加于：v1.16

browserContext.APIRequest

与此上下文关联的 API 测试助手。使用此 API 发出的请求将使用上下文 cookie。

用法

BrowserContext.APIRequest

类型

APIRequestContext

Clock

新增于: v1.45

browserContext.Clock

Playwright 能够模拟时钟和时间流逝。

用法

BrowserContext.Clock

类型

时钟

Credentials

添加于：v1.61

browserContext.Credentials

此上下文的虚拟 WebAuthn 身份验证器。允许测试注入凭据并拦截 navigator.credentials.create() / navigator.credentials.get() 流程。

用法

BrowserContext.Credentials

类型

凭据

Debugger

新增于: v1.59

browserContext.Debugger

调试器允许暂停和恢复执行。

用法

BrowserContext.Debugger

类型

调试器

Tracing

添加于：v1.12

browserContext.Tracing

用法

BrowserContext.Tracing

类型

Tracing

Events

event Close

v1.9 之前添加

browserContext.event Close

当浏览器上下文关闭时触发。这可能由于以下原因之一发生：

浏览器上下文已关闭。
浏览器应用程序已关闭或崩溃。
调用了 Browser.CloseAsync() 方法。

用法

BrowserContext.Close += async (_, browserContext) => {};

事件数据

BrowserContext

event Console

新增于: v1.34

browserContext.event Console

当页面中的 JavaScript 调用其中一个 console API 方法（例如 console.log 或 console.dir）时触发。

传入 console.log 和页面的参数在 ConsoleMessage 事件处理程序参数上可用。

用法

context.Console += async (_, msg) =>
{
    foreach (var arg in msg.Args)
        Console.WriteLine(await arg.JsonValueAsync<object>());
};

await page.EvaluateAsync("console.log('hello', 5, { foo: 'bar' })");

事件数据

ConsoleMessage

event Dialog

新增于: v1.34

browserContext.event Dialog

当 JavaScript 对话框（例如 alert、prompt、confirm 或 beforeunload）出现时发出。侦听器必须 Dialog.AcceptAsync() 或 Dialog.DismissAsync() 该对话框，否则页面将冻结等待对话框，并且像点击这样的操作将永远不会完成。

用法

Context.Dialog += async (_, dialog) =>
{
    await dialog.AcceptAsync();
};

注意

当不存在 Page.Dialog 或 BrowserContext.Dialog 侦听器时，所有对话框都会自动关闭。

事件数据

Dialog

event Download

添加于: v1.60

browserContext.event Download

当属于此上下文的任何页面中开始附件下载时发出。用户可以通过传递的 Download 实例访问下载内容的基本文件操作。另请参阅 Page.Download 以接收有关特定页面的事件。

用法

BrowserContext.Download += async (_, download) => {};

事件数据

Download

event FrameAttached

添加于: v1.60

browserContext.event FrameAttached

当属于此上下文的任何页面中附加 frame 时发出。另请参阅 Page.FrameAttached 以接收有关特定页面的事件。

用法

BrowserContext.FrameAttached += async (_, frame) => {};

事件数据

Frame

event FrameDetached

添加于: v1.60

browserContext.event FrameDetached

当属于此上下文的任何页面中分离 frame 时发出。另请参阅 Page.FrameDetached 以接收有关特定页面的事件。

用法

BrowserContext.FrameDetached += async (_, frame) => {};

事件数据

Frame

event FrameNavigated

添加于: v1.60

browserContext.event FrameNavigated

当属于此上下文的任何页面中的 frame 导航到新 url 时发出。另请参阅 Page.FrameNavigated 以接收有关特定页面导航的事件。

用法

BrowserContext.FrameNavigated += async (_, frame) => {};

事件数据

Frame

event Page

v1.9 之前添加

browserContext.event Page

当在 BrowserContext 中创建新 Page 时发出该事件。页面可能仍在加载中。该事件也将为弹出窗口页面触发。另请参阅 Page.Popup 以接收有关特定页面相关的弹出窗口事件。

页面可用的最早时刻是它导航到初始 url 时。例如，当使用 window.open('http://example.com') 打开弹出窗口时，此事件将在对 "http://example.com" 的网络请求完成并且其响应已开始在弹出窗口中加载时触发。如果您想路由/监听此网络请求，请分别使用 BrowserContext.RouteAsync() 和 BrowserContext.Request，而不是使用 Page 上的类似方法。

var popup = await context.RunAndWaitForPageAsync(async =>
{
    await page.GetByText("open new page").ClickAsync();
});
Console.WriteLine(await popup.EvaluateAsync<string>("location.href"));

注意

使用 Page.WaitForLoadStateAsync() 等待直到页面达到特定状态（大多数情况下您不需要它）。

用法

BrowserContext.Page += async (_, page) => {};

事件数据

Page

event PageClose

添加于: v1.60

browserContext.event PageClose

当此上下文中的页面关闭时发出。另请参阅 Page.Close 以接收有关特定页面的事件。

用法

BrowserContext.PageClose += async (_, page) => {};

事件数据

Page

event PageLoad

添加于: v1.60

browserContext.event PageLoad

当 JavaScript load 事件在属于此上下文的任何页面中分派时发出。另请参阅 Page.Load 以接收有关特定页面的事件。

用法

BrowserContext.PageLoad += async (_, page) => {};

事件数据

Page

event Request

添加于：v1.12

browserContext.event Request

当通过此上下文创建的任何页面发出请求时发出。该 request 对象是只读的。要仅监听来自特定页面的请求，请使用 Page.Request。

为了拦截和修改请求，请参阅 BrowserContext.RouteAsync() 或 Page.RouteAsync()。

用法

BrowserContext.Request += async (_, request) => {};

事件数据

Request

event RequestFailed

添加于：v1.12

browserContext.event RequestFailed

当请求失败时发出，例如通过超时。要仅监听来自特定页面的失败请求，请使用 Page.RequestFailed。

注意

HTTP 错误响应（如 404 或 503）从 HTTP 立场来看仍然是成功的响应，因此请求将通过 BrowserContext.RequestFinished 事件完成，而不是通过 BrowserContext.RequestFailed 完成。

用法

BrowserContext.RequestFailed += async (_, request) => {};

事件数据

Request

event RequestFinished

添加于：v1.12

browserContext.event RequestFinished

当请求在下载响应正文后成功完成时发出。对于成功的响应，事件序列是 request、response 和 requestfinished。要监听来自特定页面的成功请求，请使用 Page.RequestFinished。

用法

BrowserContext.RequestFinished += async (_, request) => {};

事件数据

Request

event Response

添加于：v1.12

browserContext.event Response

当收到请求的 response 状态和标头时发出。对于成功的响应，事件序列是 request、response 和 requestfinished。要监听来自特定页面的响应事件，请使用 Page.Response。

用法

BrowserContext.Response += async (_, response) => {};

事件数据

Response

event WebError

新增于: v1.38

browserContext.event WebError

当此上下文中的任何页面中发生未处理的异常时发出。要监听来自特定页面的错误，请改为使用 Page.PageError。

用法

BrowserContext.WebError += async (_, webError) => {};

事件数据

WebError

已弃用

event BackgroundPage

添加于：v1.11

browserContext.event BackgroundPage

已弃用

后台页面已从 Chromium 与 Manifest V2 扩展一起移除。

不触发此事件。

用法

BrowserContext.BackgroundPage += async (_, page) => {};

事件数据

Page

BackgroundPages

添加于：v1.11

browserContext.BackgroundPages

已弃用

后台页面已从 Chromium 与 Manifest V2 扩展一起移除。

返回一个空列表。

用法

BrowserContext.BackgroundPages

IReadOnlyList<Page>#

方法​

AddCookiesAsync​

AddInitScriptAsync​

Browser​

ClearCookiesAsync​

ClearPermissionsAsync​

CloseAsync​

CookiesAsync​

ExposeBindingAsync​

ExposeFunctionAsync​

GrantPermissionsAsync​

IsClosed​

NewCDPSessionAsync​

NewPageAsync​

Pages​

RouteAsync​

RouteFromHARAsync​

RouteWebSocketAsync​

RunAndWaitForConsoleMessageAsync​

WaitForConsoleMessageAsync​

RunAndWaitForPageAsync​

WaitForPageAsync​

SetDefaultNavigationTimeout​

SetDefaultTimeout​

SetExtraHTTPHeadersAsync​

SetGeolocationAsync​

SetOfflineAsync​

SetStorageStateAsync​

StorageStateAsync​

UnrouteAsync​

UnrouteAllAsync​

属性​

APIRequest​

Clock​

Credentials​

Debugger​

Tracing​

Events​

event Close​

event Console​

event Dialog​

event Download​

event FrameAttached​

event FrameDetached​

event FrameNavigated​

event Page​

event PageClose​

event PageLoad​

event Request​

event RequestFailed​

event RequestFinished​

event Response​

event WebError​

已弃用​

event BackgroundPage​

BackgroundPages​

方法

AddCookiesAsync

AddInitScriptAsync

Browser

ClearCookiesAsync

ClearPermissionsAsync

CloseAsync

CookiesAsync

ExposeBindingAsync

ExposeFunctionAsync

GrantPermissionsAsync

IsClosed

NewCDPSessionAsync

NewPageAsync

Pages

RouteAsync

RouteFromHARAsync

RouteWebSocketAsync

RunAndWaitForConsoleMessageAsync

WaitForConsoleMessageAsync

RunAndWaitForPageAsync

WaitForPageAsync

SetDefaultNavigationTimeout

SetDefaultTimeout

SetExtraHTTPHeadersAsync

SetGeolocationAsync

SetOfflineAsync

SetStorageStateAsync

StorageStateAsync

UnrouteAsync

UnrouteAllAsync

属性

APIRequest

Clock

Credentials

Debugger

Tracing

Events

event Close

event Console

event Dialog

event Download

event FrameAttached

event FrameDetached

event FrameNavigated

event Page

event PageClose

event PageLoad

event Request

event RequestFailed

event RequestFinished

event Response

event WebError

已弃用

event BackgroundPage

BackgroundPages