How to use PageRunAndWaitForResponseOptions class of Microsoft.Playwright package

...2590        /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2591        /// URL()</c></a> constructor.2592        /// </param>2593        /// <param name="options">Call options</param>2594        Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, string urlOrPredicate, PageRunAndWaitForResponseOptions? options = default);2595        /// <summary>2596        /// <para>2597        /// Returns the matched response. See <a href="https://playwright.dev/dotnet/docs/events#waiting-for-event">waiting2598        /// for event</a> for more details about events.2599        /// </para>2600        /// <code>2601        /// // Waits for the next response with the specified url.<br/>2602        /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2603        /// {<br/>2604        ///     await page.ClickAsync("button.triggers-response");<br/>2605        /// }, "http://example.com/resource");<br/>2606        /// <br/>2607        /// // Alternative way with a predicate.<br/>2608        /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2609        /// {<br/>2610        ///     await page.ClickAsync("button");<br/>2611        /// }, response =&gt; response.Url == "https://example.com" &amp;&amp; response.Status == 200);2612        /// </code>2613        /// </summary>2614        /// <param name="action">Action that triggers the event.</param>2615        /// <param name="urlOrPredicate">2616        /// Request URL string, regex or predicate receiving <see cref="IResponse"/> object.2617        /// When a <paramref name="baseURL"/> via the context options was provided and the passed2618        /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2619        /// URL()</c></a> constructor.2620        /// </param>2621        /// <param name="options">Call options</param>2622        Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, Regex urlOrPredicate, PageRunAndWaitForResponseOptions? options = default);2623        /// <summary>2624        /// <para>2625        /// Returns the matched response. See <a href="https://playwright.dev/dotnet/docs/events#waiting-for-event">waiting2626        /// for event</a> for more details about events.2627        /// </para>2628        /// <code>2629        /// // Waits for the next response with the specified url.<br/>2630        /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2631        /// {<br/>2632        ///     await page.ClickAsync("button.triggers-response");<br/>2633        /// }, "http://example.com/resource");<br/>2634        /// <br/>2635        /// // Alternative way with a predicate.<br/>2636        /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2637        /// {<br/>2638        ///     await page.ClickAsync("button");<br/>2639        /// }, response =&gt; response.Url == "https://example.com" &amp;&amp; response.Status == 200);2640        /// </code>2641        /// </summary>2642        /// <param name="action">Action that triggers the event.</param>2643        /// <param name="urlOrPredicate">2644        /// Request URL string, regex or predicate receiving <see cref="IResponse"/> object.2645        /// When a <paramref name="baseURL"/> via the context options was provided and the passed2646        /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2647        /// URL()</c></a> constructor.2648        /// </param>2649        /// <param name="options">Call options</param>2650        Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, Func<IResponse, bool> urlOrPredicate, PageRunAndWaitForResponseOptions? options = default);2651        /// <summary>2652        /// <para>2653        /// Returns when element specified by selector satisfies <paramref name="state"/> option.2654        /// Returns <c>null</c> if waiting for <c>hidden</c> or <c>detached</c>.2655        /// </para>2656        /// <para>2657        /// Wait for the <paramref name="selector"/> to satisfy <paramref name="state"/> option2658        /// (either appear/disappear from dom, or become visible/hidden). If at the moment of2659        /// calling the method <paramref name="selector"/> already satisfies the condition,2660        /// the method will return immediately. If the selector doesn't satisfy the condition2661        /// for the <paramref name="timeout"/> milliseconds, the function will throw.2662        /// </para>2663        /// <para>This method works across navigations:</para>2664        /// <code>...

...2556    /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2557    /// URL()</c></a> constructor.2558    /// </param>2559    /// <param name="options">Call options</param>2560    public static IResponse RunAndWaitForResponse(this IPage page, Func<Task> action, string urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)2561    {2562        return page.RunAndWaitForResponseAsync(action, urlOrPredicate, options).GetAwaiter().GetResult();2563    }2564    /// <summary>2565    /// <para>2566    /// Returns the matched response. See <a href="./events.md#waiting-for-event">waiting2567    /// for event</a> for more details about events.2568    /// </para>2569    /// <code>2570    /// // Waits for the next response with the specified url.<br/>2571    /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2572    /// {<br/>2573    ///     await page.ClickAsync("button.triggers-response");<br/>2574    /// }, "http://example.com/resource");<br/>2575    /// <br/>2576    /// // Alternative way with a predicate.<br/>2577    /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2578    /// {<br/>2579    ///     await page.ClickAsync("button");<br/>2580    /// }, response =&gt; response.Url == "https://example.com" &amp;&amp; response.Status == 200);2581    /// </code>2582    /// </summary>2583    /// <param name="action">Action that triggers the event.</param>2584    /// <param name="urlOrPredicate">2585    /// Request URL string, regex or predicate receiving <see cref="IResponse"/> object.2586    /// When a <paramref name="baseURL"/> via the context options was provided and the passed2587    /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2588    /// URL()</c></a> constructor.2589    /// </param>2590    /// <param name="options">Call options</param>2591    public static IResponse RunAndWaitForResponse(this IPage page, Func<Task> action, Regex urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)2592    {2593        return page.RunAndWaitForResponseAsync(action, urlOrPredicate, options).GetAwaiter().GetResult();2594    }2595    /// <summary>2596    /// <para>2597    /// Returns the matched response. See <a href="./events.md#waiting-for-event">waiting2598    /// for event</a> for more details about events.2599    /// </para>2600    /// <code>2601    /// // Waits for the next response with the specified url.<br/>2602    /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2603    /// {<br/>2604    ///     await page.ClickAsync("button.triggers-response");<br/>2605    /// }, "http://example.com/resource");<br/>2606    /// <br/>2607    /// // Alternative way with a predicate.<br/>2608    /// await page.RunAndWaitForResponseAsync(async () =&gt;<br/>2609    /// {<br/>2610    ///     await page.ClickAsync("button");<br/>2611    /// }, response =&gt; response.Url == "https://example.com" &amp;&amp; response.Status == 200);2612    /// </code>2613    /// </summary>2614    /// <param name="action">Action that triggers the event.</param>2615    /// <param name="urlOrPredicate">2616    /// Request URL string, regex or predicate receiving <see cref="IResponse"/> object.2617    /// When a <paramref name="baseURL"/> via the context options was provided and the passed2618    /// URL is a path, it gets merged via the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/URL"><c>new2619    /// URL()</c></a> constructor.2620    /// </param>2621    /// <param name="options">Call options</param>2622    public static IResponse RunAndWaitForResponse(this IPage page, Func<Task> action, Func<IResponse, bool> urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)2623    {2624        return page.RunAndWaitForResponseAsync(action, urlOrPredicate, options).GetAwaiter().GetResult();2625    }2626    /// <summary>2627    /// <para>2628    /// Returns when element specified by selector satisfies <paramref name="state"/> option.2629    /// Returns <c>null</c> if waiting for <c>hidden</c> or <c>detached</c>.2630    /// </para>2631    /// <para>2632    /// Wait for the <paramref name="selector"/> to satisfy <paramref name="state"/> option2633    /// (either appear/disappear from dom, or become visible/hidden). If at the moment of2634    /// calling the method <paramref name="selector"/> already satisfies the condition,2635    /// the method will return immediately. If the selector doesn't satisfy the condition2636    /// for the <paramref name="timeout"/> milliseconds, the function will throw....

...313        public Task<IRequest> RunAndWaitForRequestAsync(Func<Task> action, Regex urlOrPredicate, PageRunAndWaitForRequestOptions options = default)314            => InnerWaitForEventAsync(PageEvent.Request, action, e => urlOrPredicate.IsMatch(e.Url), options?.Timeout);315        public Task<IRequest> RunAndWaitForRequestAsync(Func<Task> action, Func<IRequest, bool> urlOrPredicate, PageRunAndWaitForRequestOptions options = default)316            => InnerWaitForEventAsync(PageEvent.Request, action, e => urlOrPredicate(e), options?.Timeout);317        public Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, string urlOrPredicate, PageRunAndWaitForResponseOptions options = default)318            => InnerWaitForEventAsync(PageEvent.Response, action, e => Context.UrlMatches(e.Url, urlOrPredicate), options?.Timeout);319        public Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, Regex urlOrPredicate, PageRunAndWaitForResponseOptions options = default)320            => InnerWaitForEventAsync(PageEvent.Response, action, e => urlOrPredicate.IsMatch(e.Url), options?.Timeout);321        public Task<IResponse> RunAndWaitForResponseAsync(Func<Task> action, Func<IResponse, bool> urlOrPredicate, PageRunAndWaitForResponseOptions options = default)322            => InnerWaitForEventAsync(PageEvent.Response, action, e => urlOrPredicate(e), options?.Timeout);323        public Task<IJSHandle> WaitForFunctionAsync(string expression, object arg = default, PageWaitForFunctionOptions options = default)324            => MainFrame.WaitForFunctionAsync(expression, arg, new() { PollingInterval = options?.PollingInterval, Timeout = options?.Timeout });325        public async Task<T> InnerWaitForEventAsync<T>(PlaywrightEvent<T> pageEvent, Func<Task> action = default, Func<T, bool> predicate = default, float? timeout = default)326        {327            if (pageEvent == null)328            {329                throw new ArgumentException("Page event is required", nameof(pageEvent));330            }331            timeout ??= _defaultTimeout;332            using var waiter = new Waiter(this, $"page.WaitForEventAsync(\"{typeof(T)}\")");333            waiter.RejectOnTimeout(Convert.ToInt32(timeout), $"Timeout {timeout}ms exceeded while waiting for event \"{pageEvent.Name}\"");334            if (pageEvent.Name != PageEvent.Crash.Name)335            {...

...496    protected virtual IRequest RunAndWaitForRequestFinished(Func<Task> action, PageRunAndWaitForRequestFinishedOptions? options = null)497    {498        return this.Page.RunAndWaitForRequestFinished(action, options);499    }500    protected virtual IResponse RunAndWaitForResponse(Func<Task> action, string urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)501    {502        return this.Page.RunAndWaitForResponse(action, urlOrPredicate, options);503    }504    protected virtual IResponse RunAndWaitForResponse(Func<Task> action, Regex urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)505    {506        return this.Page.RunAndWaitForResponse(action, urlOrPredicate, options);507    }508    protected virtual IWebSocket RunAndWaitForWebSocket(Func<Task> action, PageRunAndWaitForWebSocketOptions? options = null)509    {510        return this.Page.RunAndWaitForWebSocket(action, options);511    }512    protected virtual void RunAndWaitForWorker(Func<Task> action, PageRunAndWaitForWorkerOptions? options = null)513    {514        this.Page.RunAndWaitForWorker(action, options);515    }516    protected virtual void Screenshot(PageScreenshotOptions? options = null)517    {518        this.Page.Screenshot(options);519    }520    protected virtual byte[] Pdf(PagePdfOptions? options = null)521    {522        return this.Page.Pdf(options);523    }524    protected virtual void SetContent(string html, PageSetContentOptions? options = null)525    {526        this.Page.SetContent(html, options);527    }528    protected virtual void SetExtraHTTPHeaders(IEnumerable<KeyValuePair<string, string>> headers)529    {530        this.Page.SetExtraHTTPHeaders(headers);531    }532    protected virtual void SetViewportSize(int width, int height)533    {534        this.Page.SetViewportSize(width, height);535    }536    protected virtual string? TextContent(string selector, PageTextContentOptions? options = null)537    {538        return this.Page.TextContent(selector, options);539    }540    protected virtual string Title()541    {542        return this.Page.Title();543    }544    protected virtual IConsoleMessage WaitForConsoleMessage(PageWaitForConsoleMessageOptions? options = null)545    {546        return this.Page.WaitForConsoleMessage(options);547    }548    protected virtual IDownload WaitForDownload(PageWaitForDownloadOptions? options = null)549    {550        return this.Page.WaitForDownload(options);551    }552    protected virtual IFileChooser WaitForFileChooser(PageWaitForFileChooserOptions? options = null)553    {554        return this.Page.WaitForFileChooser(options);555    }556    protected virtual IJSHandle WaitForFunction(string expression, object? arg = null, PageWaitForFunctionOptions? options = null)557    {558        return this.Page.WaitForFunction(expression, arg, options);559    }560    protected virtual void WaitForLoadState(LoadState? state = null, PageWaitForLoadStateOptions? options = null)561    {562        this.Page.WaitForLoadState(state, options);563    }564    protected virtual IResponse? WaitForNavigation(PageWaitForNavigationOptions? options = null)565    {566        return this.Page.WaitForNavigation(options);567    }568    protected virtual IPage WaitForPopup(PageWaitForPopupOptions? options = null)569    {570        return this.Page.WaitForPopup(options);571    }572    protected virtual IRequest WaitForRequest(string urlOrPredicate, PageWaitForRequestOptions? options = null)573    {574        return this.Page.WaitForRequest(urlOrPredicate, options);575    }576    protected virtual IRequest WaitForRequest(Regex urlOrPredicate, PageWaitForRequestOptions? options = null)577    {578        return this.Page.WaitForRequest(urlOrPredicate, options);579    }580    protected virtual IRequest WaitForRequest(Func<IRequest, bool> urlOrPredicate, PageWaitForRequestOptions? options = null)581    {582        return this.Page.WaitForRequest(urlOrPredicate, options);583    }584    protected virtual IRequest WaitForRequestFinished(PageWaitForRequestFinishedOptions? options = null)585    {586        return this.Page.WaitForRequestFinished(options);587    }588    protected virtual IResponse WaitForResponse(string urlOrPredicate, PageWaitForResponseOptions? options = null)589    {590        return this.Page.WaitForResponse(urlOrPredicate, options);591    }592    protected virtual IResponse WaitForResponse(Regex urlOrPredicate, PageWaitForResponseOptions? options = null)593    {594        return this.Page.WaitForResponse(urlOrPredicate, options);595    }596    protected virtual IResponse WaitForResponse(Func<IResponse, bool> urlOrPredicate, PageWaitForResponseOptions? options = null)597    {598        return this.Page.WaitForResponse(urlOrPredicate, options);599    }600    protected virtual IResponse RunAndWaitForResponse(Func<Task> action, Func<IResponse, bool> urlOrPredicate, PageRunAndWaitForResponseOptions? options = null)601    {602        return this.Page.RunAndWaitForResponse(action, urlOrPredicate, options);603    }604    protected virtual IElementHandle? WaitForSelector(string selector, PageWaitForSelectorOptions? options = null)605    {606        return this.Page.WaitForSelector(selector, options);607    }608    protected virtual void WaitForTimeout(float timeout)609    {610        this.Page.WaitForTimeout(timeout);611    }612    protected virtual void WaitForURL(Regex url, PageWaitForURLOptions? options = null)613    {614        this.Page.WaitForURL(url, options);...

...100        /// <param name="action">Action that triggers the event.</param>101        /// <param name="urlOrPredicate">Request predicate receiving <see cref="IResponse"/> object.</param>102        /// <param name="options">Call options.</param>103        /// <returns>Task which resolves to the <see cref="PageObject"/>.</returns>104        /// <seealso cref="IPage.RunAndWaitForResponseAsync(Func{Task}, Func{IResponse, bool}, PageRunAndWaitForResponseOptions)"/>105        public static async Task<T> RunAndWaitForResponseAsync<T>(this IPage page, Func<Task> action, Func<IResponse, bool> urlOrPredicate, PageRunAndWaitForResponseOptions? options = default)106            where T : PageObject107        {108            var response = await page.GuardFromNull().RunAndWaitForResponseAsync(action, urlOrPredicate, options).ConfigureAwait(false);109            return ProxyFactory.PageObject<T>(page, response)!;110        }111        // ElementObject112        /// <summary>113        /// The method finds all elements matching the specified selector within the page and returns a <see cref="IReadOnlyList{ElementObject}"/>.114        /// If no elements match the selector, the return value resolve to an empty list.115        /// </summary>116        /// <typeparam name="T">The type of <see cref="ElementObject"/>.</typeparam>117        /// <param name="page">A <see cref="IPage"/>.</param>118        /// <param name="selector">A selector to query for.</param>119        /// <returns>Task which resolves to the <see cref="IReadOnlyList{ElementObject}"/>.</returns>...

...65            await Page.GotoAsync("https://github.com/microsoft/playwright-dotnet");66            var result = await Page.RunAndWaitForResponseAsync<FakePageObject>(async () => await Page.ClickAsync("a span[data-content='Actions']"), response => response.Url == "https://api.github.com/_private/browser/stats" && response.Status == 200);67            Assert.NotNull(result);68            Assert.NotNull(result.Page);69            Assert.ThrowsAsync<TimeoutException>(async () => await Page.RunAndWaitForResponseAsync<FakePageObject>(async () => await Task.Delay(1), response => response.Url == "https://missing.com", new PageRunAndWaitForResponseOptions { Timeout = 1 }));70        }71        // ElementObject72        [Test, Timeout(TestConstants.DefaultTestTimeout)]73        public async Task QuerySelectorAllAsync_returns_proxies_of_type()74        {75            var result = await Page.QuerySelectorAllAsync<FakeElementObject>("div");76            Assert.IsNotEmpty(result);77            Assert.That(result, Is.All.Matches<FakeElementObject>(x => x.Element != null));78            result = await Page.QuerySelectorAllAsync<FakeElementObject>(".missing");79            Assert.IsEmpty(result);80        }81        [Test, Timeout(TestConstants.DefaultTestTimeout)]82        public async Task QuerySelectorAsync_returns_proxy_of_type()83        {...

...35using System.Threading.Tasks;36#nullable enable37namespace Microsoft.Playwright38{39    public class PageRunAndWaitForResponseOptions40    {41        public PageRunAndWaitForResponseOptions() { }42        public PageRunAndWaitForResponseOptions(PageRunAndWaitForResponseOptions clone)43        {44            if (clone == null)45            {46                return;47            }48            Timeout = clone.Timeout;49        }50        /// <summary>51        /// <para>52        /// Maximum wait time in milliseconds, defaults to 30 seconds, pass <c>0</c> to disable53        /// the timeout. The default value can be changed by using the <see cref="IBrowserContext.SetDefaultTimeout"/>54        /// or <see cref="IPage.SetDefaultTimeout"/> methods.55        /// </para>56        /// </summary>...

1using Microsoft.Playwright;2using System;3using System.Threading.Tasks;4{5    {6        static async Task Main(string[] args)7        {8            using var playwright = await Playwright.CreateAsync();9            await using var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions10            {11            });12            var page = await browser.NewPageAsync();13            await page.TypeAsync("input[title=\"Search\"]", "Playwright");14            await page.ClickAsync("input[value=\"Google Search\"]");15            var response = await page.WaitForResponseAsync("**/search?q=playwright**", new PageRunAndWaitForResponseOptions16            {17            });18            if (response != null)19            {20                Console.WriteLine("Response received");21            }22            {23                Console.WriteLine("Response not received");24            }25            await browser.CloseAsync();26        }27    }28}29Playwright: How to use Page.WaitForResponseAsync() to wait for a response?30Playwright: How to use Page.WaitForResponseAsync() to wait for a response with a predicate?31Playwright: How to use Page.WaitForResponseAsync() to wait for a response with a URL match?32Playwright: How to use Page.WaitForResponseAsync() to wait for a response with a URL match and a predicate?33Playwright: How to use Page.WaitForResponseAsync() to wait for a response with a URL match, a predicate and a timeout?34Playwright: How to use Page.WaitForResponseAsync() to wait for a response with a predicate and a timeout?

1using System;2using System.Collections.Generic;3using System.Threading.Tasks;4using Microsoft.Playwright;5using Microsoft.Playwright.Helpers;6using Microsoft.Playwright.Transport.Channels;7{8    {9        static async Task Main(string[] args)10        {11            using var playwright = await Playwright.CreateAsync();12            await using var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions13            {14            });15            var page = await browser.NewPageAsync();16            await page.TypeAsync("input[name='q']", "Playwright");17            var response = await page.RunAndWaitForResponseAsync("input[name='q']", () => page.Keyboard.PressAsync("Enter"));18            Console.WriteLine($"Response URL: {response.Url}");19            Console.ReadKey();20        }