Skip to content

Commit 0c753d5

Browse files
authored
ExecutionContext docs (#299)
1 parent a53d30e commit 0c753d5

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

lib/PuppeteerSharp/ExecutionContext.cs

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@
66

77
namespace PuppeteerSharp
88
{
9+
/// <summary>
10+
/// The class represents a context for JavaScript execution. Examples of JavaScript contexts are:
11+
/// Each <see cref="Frame"/> has a separate <see cref="ExecutionContext"/>
12+
/// All kind of web workers have their own contexts
13+
/// </summary>
914
public class ExecutionContext
1015
{
1116
private readonly Session _client;
1217
private readonly int _contextId;
1318

14-
public ExecutionContext(Session client, ContextPayload contextPayload, Func<dynamic, JSHandle> objectHandleFactory)
19+
internal ExecutionContext(Session client, ContextPayload contextPayload, Func<dynamic, JSHandle> objectHandleFactory)
1520
{
1621
_client = client;
1722
_contextId = contextPayload.Id;
@@ -20,8 +25,17 @@ public ExecutionContext(Session client, ContextPayload contextPayload, Func<dyna
2025
ObjectHandleFactory = objectHandleFactory;
2126
}
2227

23-
public Func<dynamic, JSHandle> ObjectHandleFactory { get; internal set; }
28+
internal Func<dynamic, JSHandle> ObjectHandleFactory { get; set; }
29+
/// <summary>
30+
/// Gets or sets the frame identifier.
31+
/// </summary>
32+
/// <value>The frame identifier.</value>
2433
public string FrameId { get; internal set; }
34+
/// <summary>
35+
/// Gets or sets a value indicating whether this <see cref="ExecutionContext"/> is the
36+
/// default context of a <see cref="Frame"/>
37+
/// </summary>
38+
/// <value><c>true</c> if is default; otherwise, <c>false</c>.</value>
2539
public bool IsDefault { get; internal set; }
2640

2741
/// <summary>

0 commit comments

Comments
 (0)