Add response example (#1350)

hardkoded · Dec 16, 2019 · d80f9c6 · d80f9c6
1 parent fded7a4
commit d80f9c6
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/lib/PuppeteerSharp/Page.cs b/lib/PuppeteerSharp/Page.cs
@@ -165,6 +165,26 @@ private Page(
         /// <summary>
         /// Raised when a <see cref="Response"/> is received.
         /// </summary>
+        /// <example>
+        /// An example of handling <see cref="Response"/> event:
+        /// <code>
+        /// <![CDATA[
+        /// var tcs = new TaskCompletionSource<string>();
+        /// page.Response += async(sender, e) =>
+        /// {
+        ///     if (e.Response.Url.Contains("script.js"))
+        ///     {
+        ///         tcs.TrySetResult(await e.Response.TextAsync());
+        ///     }
+        /// };
+        ///
+        /// await Task.WhenAll(
+        ///     page.GoToAsync(TestConstants.ServerUrl + "/grid.html"),
+        ///     tcs.Task);
+        /// Console.WriteLine(await tcs.Task);
+        /// ]]>
+        /// </code>
+        /// </example>
         public event EventHandler<ResponseCreatedEventArgs> Response;
 
         /// <summary>

diff --git a/lib/PuppeteerSharp/Response.cs b/lib/PuppeteerSharp/Response.cs
@@ -12,6 +12,11 @@ namespace PuppeteerSharp
     /// <summary>
     /// <see cref="Response"/> class represents responses which are received by page.
     /// </summary>
+    /// <seealso cref="Page.GoAsync(int, NavigationOptions)"/>
+    /// <seealso cref="Page.GoForwardAsync(NavigationOptions)"/>
+    /// <seealso cref="Page.ReloadAsync(int?, WaitUntilNavigation[])"/>
+    /// <seealso cref="Page.Response"/>
+    /// <seealso cref="Page.WaitForResponseAsync(Func{Response, bool}, WaitForOptions)"/>
     public class Response
     {
         private readonly CDPSession _client;