Class BrowsingContextModule

Namespace

OpenQA.Selenium.BiDi.Modules.BrowsingContext

Assembly

WebDriver.dll

public class BrowsingContextModule : Module

Inheritance

object

Module

BrowsingContextModule

Inherited Members

Module.Broker

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BrowsingContextModule(Broker)

public BrowsingContextModule(Broker broker)

Parameters

broker Broker

Methods

ActivateAsync(BrowsingContext, ActivateOptions?)

public Task ActivateAsync(BrowsingContext context, ActivateOptions? options = null)

Parameters

context BrowsingContext

options ActivateOptions

Returns

Task

CaptureScreenshotAsync(BrowsingContext, CaptureScreenshotOptions?)

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

Parameters

context BrowsingContext

options CaptureScreenshotOptions

Returns

Task<CaptureScreenshotResult>

CloseAsync(BrowsingContext, CloseOptions?)

public Task CloseAsync(BrowsingContext context, CloseOptions? options = null)

Parameters

context BrowsingContext

options CloseOptions

Returns

Task

CreateAsync(ContextType, CreateOptions?)

public Task<BrowsingContext> CreateAsync(ContextType type, CreateOptions? options = null)

Parameters

type ContextType

options CreateOptions

Returns

Task<BrowsingContext>

GetTreeAsync(GetTreeOptions?)

public Task<IReadOnlyList<BrowsingContextInfo>> GetTreeAsync(GetTreeOptions? options = null)

Parameters

options GetTreeOptions

Returns

Task<IReadOnlyList<BrowsingContextInfo>>

HandleUserPromptAsync(BrowsingContext, HandleUserPromptOptions?)

public Task HandleUserPromptAsync(BrowsingContext context, HandleUserPromptOptions? options = null)

Parameters

context BrowsingContext

options HandleUserPromptOptions

Returns

Task

LocateNodesAsync(BrowsingContext, Locator, LocateNodesOptions?)

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

Parameters

context BrowsingContext

locator Locator

options LocateNodesOptions

Returns

Task<LocateNodesResult>

NavigateAsync(BrowsingContext, string, NavigateOptions?)

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

Parameters

context BrowsingContext

url string

options NavigateOptions

Returns

Task<NavigateResult>

OnContextCreatedAsync(Action<BrowsingContextInfo>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnContextCreatedAsync(Action<BrowsingContextInfo> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Action<BrowsingContextInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnContextCreatedAsync(Func<BrowsingContextInfo, Task>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnContextCreatedAsync(Func<BrowsingContextInfo, Task> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Func<BrowsingContextInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnContextDestroyedAsync(Action<BrowsingContextInfo>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnContextDestroyedAsync(Action<BrowsingContextInfo> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Action<BrowsingContextInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnContextDestroyedAsync(Func<BrowsingContextInfo, Task>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnContextDestroyedAsync(Func<BrowsingContextInfo, Task> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Func<BrowsingContextInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnDomContentLoadedAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnDownloadWillBeginAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnDownloadWillBeginAsync(Action<NavigationInfo> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnDownloadWillBeginAsync(Func<NavigationInfo, Task>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnDownloadWillBeginAsync(Func<NavigationInfo, Task> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnFragmentNavigatedAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnLoadAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnNavigationAbortedAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnNavigationFailedAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnNavigationStartedAsync(Action<NavigationInfo>, BrowsingContextsSubscriptionOptions?)

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

Parameters

handler Action<NavigationInfo>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

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

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

Parameters

handler Func<NavigationInfo, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnUserPromptClosedAsync(Action<UserPromptClosedEventArgs>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnUserPromptClosedAsync(Action<UserPromptClosedEventArgs> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Action<UserPromptClosedEventArgs>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnUserPromptClosedAsync(Func<UserPromptClosedEventArgs, Task>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnUserPromptClosedAsync(Func<UserPromptClosedEventArgs, Task> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Func<UserPromptClosedEventArgs, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnUserPromptOpenedAsync(Action<UserPromptOpenedEventArgs>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnUserPromptOpenedAsync(Action<UserPromptOpenedEventArgs> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Action<UserPromptOpenedEventArgs>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

OnUserPromptOpenedAsync(Func<UserPromptOpenedEventArgs, Task>, BrowsingContextsSubscriptionOptions?)

public Task<Subscription> OnUserPromptOpenedAsync(Func<UserPromptOpenedEventArgs, Task> handler, BrowsingContextsSubscriptionOptions? options = null)

Parameters

handler Func<UserPromptOpenedEventArgs, Task>

options BrowsingContextsSubscriptionOptions

Returns

Task<Subscription>

PrintAsync(BrowsingContext, PrintOptions?)

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

Parameters

context BrowsingContext

options PrintOptions

Returns

Task<PrintResult>

ReloadAsync(BrowsingContext, ReloadOptions?)

public Task<NavigateResult> ReloadAsync(BrowsingContext context, ReloadOptions? options = null)

Parameters

context BrowsingContext

options ReloadOptions

Returns

Task<NavigateResult>

SetViewportAsync(BrowsingContext, SetViewportOptions?)

public Task SetViewportAsync(BrowsingContext context, SetViewportOptions? options = null)

Parameters

context BrowsingContext

options SetViewportOptions

Returns

Task

TraverseHistoryAsync(BrowsingContext, int, TraverseHistoryOptions?)

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

Parameters

context BrowsingContext

delta int

options TraverseHistoryOptions

Returns

Task<TraverseHistoryResult>