Class BrowsingContext

Namespace

OpenQA.Selenium.BiDi.BrowsingContext

Assembly

WebDriver.dll

public sealed record BrowsingContext : IEquatable<BrowsingContext>

Inheritance

object

BrowsingContext

Implements

IEquatable<BrowsingContext>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Constructors

BrowsingContext(BiDi, string)

public BrowsingContext(BiDi bidi, string id)

Parameters

bidi BiDi

id string

Properties

BiDi

[JsonIgnore]
public BiDi BiDi { get; }

Property Value

BiDi

Input

[JsonIgnore]
public BrowsingContextInputModule Input { get; }

Property Value

BrowsingContextInputModule

Log

[JsonIgnore]
public BrowsingContextLogModule Log { get; }

Property Value

BrowsingContextLogModule

Network

[JsonIgnore]
public BrowsingContextNetworkModule Network { get; }

Property Value

BrowsingContextNetworkModule

Script

[JsonIgnore]
public BrowsingContextScriptModule Script { get; }

Property Value

BrowsingContextScriptModule

Storage

[JsonIgnore]
public BrowsingContextStorageModule Storage { get; }

Property Value

BrowsingContextStorageModule

Methods

ActivateAsync(ActivateOptions?)

public Task<ActivateResult> ActivateAsync(ActivateOptions? options = null)

Parameters

options ActivateOptions

Returns

Task<ActivateResult>

CaptureScreenshotAsync(CaptureScreenshotOptions?)

public Task<CaptureScreenshotResult> CaptureScreenshotAsync(CaptureScreenshotOptions? options = null)

Parameters

options CaptureScreenshotOptions

Returns

Task<CaptureScreenshotResult>

CloseAsync(CloseOptions?)

public Task<CloseResult> CloseAsync(CloseOptions? options = null)

Parameters

options CloseOptions

Returns

Task<CloseResult>

Equals(BrowsingContext?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(BrowsingContext? other)

Parameters

other BrowsingContext

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetTreeAsync(BrowsingContextGetTreeOptions?)

public Task<GetTreeResult> GetTreeAsync(BrowsingContextGetTreeOptions? options = null)

Parameters

options BrowsingContextGetTreeOptions

Returns

Task<GetTreeResult>

HandleUserPromptAsync(HandleUserPromptOptions?)

public Task<HandleUserPromptResult> HandleUserPromptAsync(HandleUserPromptOptions? options = null)

Parameters

options HandleUserPromptOptions

Returns

Task<HandleUserPromptResult>

LocateNodesAsync(Locator, LocateNodesOptions?)

public Task<LocateNodesResult> LocateNodesAsync(Locator locator, LocateNodesOptions? options = null)

Parameters

locator Locator

options LocateNodesOptions

Returns

Task<LocateNodesResult>

NavigateAsync(string, NavigateOptions?)

public Task<NavigateResult> NavigateAsync(string url, NavigateOptions? options = null)

Parameters

url string

options NavigateOptions

Returns

Task<NavigateResult>

OnDomContentLoadedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnDomContentLoadedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnDomContentLoadedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnDomContentLoadedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnDownloadEndAsync(Action<DownloadEndEventArgs>, ContextSubscriptionOptions?)

public Task<Subscription> OnDownloadEndAsync(Action<DownloadEndEventArgs> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<DownloadEndEventArgs>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnDownloadEndAsync(Func<DownloadEndEventArgs, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnDownloadEndAsync(Func<DownloadEndEventArgs, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<DownloadEndEventArgs, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnDownloadWillBeginAsync(Action<DownloadWillBeginEventArgs>, ContextSubscriptionOptions?)

public Task<Subscription> OnDownloadWillBeginAsync(Action<DownloadWillBeginEventArgs> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<DownloadWillBeginEventArgs>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnDownloadWillBeginAsync(Func<DownloadWillBeginEventArgs, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnDownloadWillBeginAsync(Func<DownloadWillBeginEventArgs, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<DownloadWillBeginEventArgs, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnFragmentNavigatedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnFragmentNavigatedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnFragmentNavigatedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnFragmentNavigatedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnHistoryUpdatedAsync(Action<HistoryUpdatedEventArgs>, ContextSubscriptionOptions?)

public Task<Subscription> OnHistoryUpdatedAsync(Action<HistoryUpdatedEventArgs> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<HistoryUpdatedEventArgs>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnHistoryUpdatedAsync(Func<HistoryUpdatedEventArgs, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnHistoryUpdatedAsync(Func<HistoryUpdatedEventArgs, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<HistoryUpdatedEventArgs, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnLoadAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnLoadAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnLoadAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnLoadAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationAbortedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationAbortedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationAbortedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationAbortedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationCommittedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationCommittedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationCommittedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationCommittedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationFailedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationFailedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationFailedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationFailedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationStartedAsync(Action<NavigationInfo>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationStartedAsync(Action<NavigationInfo> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options ContextSubscriptionOptions

Returns

Task<Subscription>

OnNavigationStartedAsync(Func<NavigationInfo, Task>, ContextSubscriptionOptions?)

public Task<Subscription> OnNavigationStartedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options ContextSubscriptionOptions

Returns

Task<Subscription>

PrintAsync(PrintOptions?)

public Task<PrintResult> PrintAsync(PrintOptions? options = null)

Parameters

options PrintOptions

Returns

Task<PrintResult>

ReloadAsync(ReloadOptions?)

public Task<ReloadResult> ReloadAsync(ReloadOptions? options = null)

Parameters

options ReloadOptions

Returns

Task<ReloadResult>

SetViewportAsync(SetViewportOptions?)

public Task<SetViewportResult> SetViewportAsync(SetViewportOptions? options = null)

Parameters

options SetViewportOptions

Returns

Task<SetViewportResult>

TraverseHistoryAsync(int, TraverseHistoryOptions?)

public Task<TraverseHistoryResult> TraverseHistoryAsync(int delta, TraverseHistoryOptions? options = null)

Parameters

delta int

options TraverseHistoryOptions

Returns

Task<TraverseHistoryResult>