mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-14 13:45:36 +03:00
docs(dotnet): add support for CDPSession (#20053)
Implemented in https://github.com/microsoft/playwright-dotnet/pull/2448 Signed-off-by: Jeremy Hutchinson <jrhutch@live.com> Co-authored-by: Jeremy Hutchinson <jehutchi@microsoft.com> Co-authored-by: Max Schmitt <max@schmitt.mx>
This commit is contained in:
parent
5761a62b1c
commit
bc134551fb
@ -155,7 +155,7 @@ Indicates that the browser is connected.
|
||||
|
||||
## async method: Browser.newBrowserCDPSession
|
||||
* since: v1.11
|
||||
* langs: js, python
|
||||
* langs: js, python, csharp
|
||||
- returns: <[CDPSession]>
|
||||
|
||||
:::note
|
||||
|
@ -857,7 +857,7 @@ The [origin] to grant permissions to, e.g. "https://example.com".
|
||||
|
||||
## async method: BrowserContext.newCDPSession
|
||||
* since: v1.11
|
||||
* langs: js, python
|
||||
* langs: js, python, csharp
|
||||
- returns: <[CDPSession]>
|
||||
|
||||
:::note
|
||||
|
@ -1,6 +1,6 @@
|
||||
# class: CDPSession
|
||||
* since: v1.8
|
||||
* langs: js, python
|
||||
* langs: js, python, csharp
|
||||
* extends: [EventEmitter]
|
||||
|
||||
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
|
||||
@ -45,6 +45,15 @@ client.send("Animation.setPlaybackRate", {
|
||||
playbackRate: response["playbackRate"] / 2
|
||||
})
|
||||
```
|
||||
```csharp
|
||||
var client = await Page.Context.NewCDPSessionAsync(Page);
|
||||
await client.SendAsync("Runtime.enable");
|
||||
client.Event("Animation.animationCreated").OnEvent += (_, _) => Console.WriteLine("Animation created!");
|
||||
var response = await client.SendAsync("Animation.getPlaybackRate");
|
||||
var playbackRate = response.Value.GetProperty("playbackRate").GetDouble();
|
||||
Console.WriteLine("playback rate is " + playbackRate);
|
||||
await client.SendAsync("Animation.setPlaybackRate", new() { { "playbackRate", playbackRate / 2 } });
|
||||
```
|
||||
|
||||
## async method: CDPSession.detach
|
||||
* since: v1.8
|
||||
@ -54,16 +63,46 @@ send messages.
|
||||
|
||||
## async method: CDPSession.send
|
||||
* since: v1.8
|
||||
* langs: js, python, csharp
|
||||
- returns: <[Object]>
|
||||
|
||||
## async method: CDPSession.send
|
||||
* since: v1.30
|
||||
* langs: csharp
|
||||
- returns: <[JsonElement?]>
|
||||
|
||||
### param: CDPSession.send.method
|
||||
* since: v1.8
|
||||
* langs: js, python, csharp
|
||||
- `method` <[string]>
|
||||
|
||||
Protocol method name.
|
||||
|
||||
### param: CDPSession.send.params
|
||||
* since: v1.8
|
||||
* langs: js, python
|
||||
- `params` ?<[Object]>
|
||||
|
||||
Optional method parameters.
|
||||
|
||||
### param: CDPSession.send.params
|
||||
* since: v1.30
|
||||
* langs: csharp
|
||||
- alias-csharp: args
|
||||
- `params` ?<[Map<string, Object>]>
|
||||
|
||||
Optional method parameters.
|
||||
|
||||
## method: CDPSession.event
|
||||
* since: v.1.30
|
||||
* langs: csharp
|
||||
- returns: <[CDPSessionEvent]>
|
||||
|
||||
Returns an event emitter for the given CDP event name.
|
||||
|
||||
### param: CDPSession.event.eventName
|
||||
* since: v1.30
|
||||
* langs: csharp
|
||||
- `eventName` <[string]>
|
||||
|
||||
CDP event name.
|
17
docs/src/api/class-cdpsessionevent.md
Normal file
17
docs/src/api/class-cdpsessionevent.md
Normal file
@ -0,0 +1,17 @@
|
||||
# class: CDPSessionEvent
|
||||
* since: v1.30
|
||||
* langs: csharp
|
||||
|
||||
[CDPSessionEvent] objects are returned by page via the [`method: CDPSession.event`] method.
|
||||
|
||||
Each object represents a named event and allows handling of the event when it is raised.
|
||||
|
||||
## event: CDPSessionEvent.onEvent
|
||||
* since: v1.30
|
||||
* langs: csharp
|
||||
- argument: <[JsonElement?]>
|
||||
|
||||
## property: CDPSessionEvent.eventName
|
||||
* since: 1.30
|
||||
* langs: csharp
|
||||
- returns: <[string]>
|
Loading…
Reference in New Issue
Block a user