118 lines
11 KiB
Markdown
118 lines
11 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Page](./puppeteer.protocol.page.md)
|
|
|
|
## Protocol.Page namespace
|
|
|
|
Actions and events related to the inspected page belong to the page domain.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export namespace Page
|
|
```
|
|
|
|
## Interfaces
|
|
|
|
| Interface | Description |
|
|
| --- | --- |
|
|
| [AddCompilationCacheRequest](./puppeteer.protocol.page.addcompilationcacherequest.md) | |
|
|
| [AddScriptToEvaluateOnLoadRequest](./puppeteer.protocol.page.addscripttoevaluateonloadrequest.md) | |
|
|
| [AddScriptToEvaluateOnLoadResponse](./puppeteer.protocol.page.addscripttoevaluateonloadresponse.md) | |
|
|
| [AddScriptToEvaluateOnNewDocumentRequest](./puppeteer.protocol.page.addscripttoevaluateonnewdocumentrequest.md) | |
|
|
| [AddScriptToEvaluateOnNewDocumentResponse](./puppeteer.protocol.page.addscripttoevaluateonnewdocumentresponse.md) | |
|
|
| [AppManifestError](./puppeteer.protocol.page.appmanifesterror.md) | Error while paring app manifest. |
|
|
| [AppManifestParsedProperties](./puppeteer.protocol.page.appmanifestparsedproperties.md) | Parsed app manifest properties. |
|
|
| [CaptureScreenshotRequest](./puppeteer.protocol.page.capturescreenshotrequest.md) | |
|
|
| [CaptureScreenshotResponse](./puppeteer.protocol.page.capturescreenshotresponse.md) | |
|
|
| [CaptureSnapshotRequest](./puppeteer.protocol.page.capturesnapshotrequest.md) | |
|
|
| [CaptureSnapshotResponse](./puppeteer.protocol.page.capturesnapshotresponse.md) | |
|
|
| [CompilationCacheProducedEvent](./puppeteer.protocol.page.compilationcacheproducedevent.md) | Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled. |
|
|
| [CreateIsolatedWorldRequest](./puppeteer.protocol.page.createisolatedworldrequest.md) | |
|
|
| [CreateIsolatedWorldResponse](./puppeteer.protocol.page.createisolatedworldresponse.md) | |
|
|
| [DeleteCookieRequest](./puppeteer.protocol.page.deletecookierequest.md) | |
|
|
| [DomContentEventFiredEvent](./puppeteer.protocol.page.domcontenteventfiredevent.md) | |
|
|
| [DownloadProgressEvent](./puppeteer.protocol.page.downloadprogressevent.md) | Fired when download makes progress. Last call has \|done\| == true. |
|
|
| [DownloadWillBeginEvent](./puppeteer.protocol.page.downloadwillbeginevent.md) | Fired when page is about to start a download. |
|
|
| [FileChooserOpenedEvent](./puppeteer.protocol.page.filechooseropenedevent.md) | Emitted only when <code>page.interceptFileChooser</code> is enabled. |
|
|
| [FontFamilies](./puppeteer.protocol.page.fontfamilies.md) | Generic font families collection. |
|
|
| [FontSizes](./puppeteer.protocol.page.fontsizes.md) | Default font sizes. |
|
|
| [Frame](./puppeteer.protocol.page.frame.md) | Information about the Frame on the page. |
|
|
| [FrameAttachedEvent](./puppeteer.protocol.page.frameattachedevent.md) | Fired when frame has been attached to its parent. |
|
|
| [FrameClearedScheduledNavigationEvent](./puppeteer.protocol.page.frameclearedschedulednavigationevent.md) | Fired when frame no longer has a scheduled navigation. |
|
|
| [FrameDetachedEvent](./puppeteer.protocol.page.framedetachedevent.md) | Fired when frame has been detached from its parent. |
|
|
| [FrameNavigatedEvent](./puppeteer.protocol.page.framenavigatedevent.md) | Fired once navigation of the frame has completed. Frame is now associated with the new loader. |
|
|
| [FrameRequestedNavigationEvent](./puppeteer.protocol.page.framerequestednavigationevent.md) | Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued. |
|
|
| [FrameResource](./puppeteer.protocol.page.frameresource.md) | Information about the Resource on the page. |
|
|
| [FrameResourceTree](./puppeteer.protocol.page.frameresourcetree.md) | Information about the Frame hierarchy along with their cached resources. |
|
|
| [FrameScheduledNavigationEvent](./puppeteer.protocol.page.frameschedulednavigationevent.md) | Fired when frame schedules a potential navigation. |
|
|
| [FrameStartedLoadingEvent](./puppeteer.protocol.page.framestartedloadingevent.md) | Fired when frame has started loading. |
|
|
| [FrameStoppedLoadingEvent](./puppeteer.protocol.page.framestoppedloadingevent.md) | Fired when frame has stopped loading. |
|
|
| [FrameTree](./puppeteer.protocol.page.frametree.md) | Information about the Frame hierarchy. |
|
|
| [GenerateTestReportRequest](./puppeteer.protocol.page.generatetestreportrequest.md) | |
|
|
| [GetAppManifestResponse](./puppeteer.protocol.page.getappmanifestresponse.md) | |
|
|
| [GetCookiesResponse](./puppeteer.protocol.page.getcookiesresponse.md) | |
|
|
| [GetFrameTreeResponse](./puppeteer.protocol.page.getframetreeresponse.md) | |
|
|
| [GetInstallabilityErrorsResponse](./puppeteer.protocol.page.getinstallabilityerrorsresponse.md) | |
|
|
| [GetLayoutMetricsResponse](./puppeteer.protocol.page.getlayoutmetricsresponse.md) | |
|
|
| [GetManifestIconsResponse](./puppeteer.protocol.page.getmanifesticonsresponse.md) | |
|
|
| [GetNavigationHistoryResponse](./puppeteer.protocol.page.getnavigationhistoryresponse.md) | |
|
|
| [GetResourceContentRequest](./puppeteer.protocol.page.getresourcecontentrequest.md) | |
|
|
| [GetResourceContentResponse](./puppeteer.protocol.page.getresourcecontentresponse.md) | |
|
|
| [GetResourceTreeResponse](./puppeteer.protocol.page.getresourcetreeresponse.md) | |
|
|
| [HandleJavaScriptDialogRequest](./puppeteer.protocol.page.handlejavascriptdialogrequest.md) | |
|
|
| [InstallabilityError](./puppeteer.protocol.page.installabilityerror.md) | The installability error |
|
|
| [InstallabilityErrorArgument](./puppeteer.protocol.page.installabilityerrorargument.md) | |
|
|
| [JavascriptDialogClosedEvent](./puppeteer.protocol.page.javascriptdialogclosedevent.md) | Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed. |
|
|
| [JavascriptDialogOpeningEvent](./puppeteer.protocol.page.javascriptdialogopeningevent.md) | Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open. |
|
|
| [LayoutViewport](./puppeteer.protocol.page.layoutviewport.md) | Layout viewport position and dimensions. |
|
|
| [LifecycleEventEvent](./puppeteer.protocol.page.lifecycleeventevent.md) | Fired for top level page lifecycle events such as navigation, load, paint, etc. |
|
|
| [LoadEventFiredEvent](./puppeteer.protocol.page.loadeventfiredevent.md) | |
|
|
| [NavigatedWithinDocumentEvent](./puppeteer.protocol.page.navigatedwithindocumentevent.md) | Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation. |
|
|
| [NavigateRequest](./puppeteer.protocol.page.navigaterequest.md) | |
|
|
| [NavigateResponse](./puppeteer.protocol.page.navigateresponse.md) | |
|
|
| [NavigateToHistoryEntryRequest](./puppeteer.protocol.page.navigatetohistoryentryrequest.md) | |
|
|
| [NavigationEntry](./puppeteer.protocol.page.navigationentry.md) | Navigation history entry. |
|
|
| [PrintToPDFRequest](./puppeteer.protocol.page.printtopdfrequest.md) | |
|
|
| [PrintToPDFResponse](./puppeteer.protocol.page.printtopdfresponse.md) | |
|
|
| [ReloadRequest](./puppeteer.protocol.page.reloadrequest.md) | |
|
|
| [RemoveScriptToEvaluateOnLoadRequest](./puppeteer.protocol.page.removescripttoevaluateonloadrequest.md) | |
|
|
| [RemoveScriptToEvaluateOnNewDocumentRequest](./puppeteer.protocol.page.removescripttoevaluateonnewdocumentrequest.md) | |
|
|
| [ScreencastFrameAckRequest](./puppeteer.protocol.page.screencastframeackrequest.md) | |
|
|
| [ScreencastFrameEvent](./puppeteer.protocol.page.screencastframeevent.md) | Compressed image data requested by the <code>startScreencast</code>. |
|
|
| [ScreencastFrameMetadata](./puppeteer.protocol.page.screencastframemetadata.md) | Screencast frame metadata. |
|
|
| [ScreencastVisibilityChangedEvent](./puppeteer.protocol.page.screencastvisibilitychangedevent.md) | Fired when the page with currently enabled screencast was shown or hidden \`<!-- -->. |
|
|
| [SearchInResourceRequest](./puppeteer.protocol.page.searchinresourcerequest.md) | |
|
|
| [SearchInResourceResponse](./puppeteer.protocol.page.searchinresourceresponse.md) | |
|
|
| [SetAdBlockingEnabledRequest](./puppeteer.protocol.page.setadblockingenabledrequest.md) | |
|
|
| [SetBypassCSPRequest](./puppeteer.protocol.page.setbypasscsprequest.md) | |
|
|
| [SetDeviceMetricsOverrideRequest](./puppeteer.protocol.page.setdevicemetricsoverriderequest.md) | |
|
|
| [SetDeviceOrientationOverrideRequest](./puppeteer.protocol.page.setdeviceorientationoverriderequest.md) | |
|
|
| [SetDocumentContentRequest](./puppeteer.protocol.page.setdocumentcontentrequest.md) | |
|
|
| [SetDownloadBehaviorRequest](./puppeteer.protocol.page.setdownloadbehaviorrequest.md) | |
|
|
| [SetFontFamiliesRequest](./puppeteer.protocol.page.setfontfamiliesrequest.md) | |
|
|
| [SetFontSizesRequest](./puppeteer.protocol.page.setfontsizesrequest.md) | |
|
|
| [SetGeolocationOverrideRequest](./puppeteer.protocol.page.setgeolocationoverriderequest.md) | |
|
|
| [SetInterceptFileChooserDialogRequest](./puppeteer.protocol.page.setinterceptfilechooserdialogrequest.md) | |
|
|
| [SetLifecycleEventsEnabledRequest](./puppeteer.protocol.page.setlifecycleeventsenabledrequest.md) | |
|
|
| [SetProduceCompilationCacheRequest](./puppeteer.protocol.page.setproducecompilationcacherequest.md) | |
|
|
| [SetTouchEmulationEnabledRequest](./puppeteer.protocol.page.settouchemulationenabledrequest.md) | |
|
|
| [SetWebLifecycleStateRequest](./puppeteer.protocol.page.setweblifecyclestaterequest.md) | |
|
|
| [StartScreencastRequest](./puppeteer.protocol.page.startscreencastrequest.md) | |
|
|
| [Viewport](./puppeteer.protocol.page.viewport.md) | Viewport for capturing screenshot. |
|
|
| [VisualViewport](./puppeteer.protocol.page.visualviewport.md) | Visual viewport position, dimensions, and scale. |
|
|
| [WindowOpenEvent](./puppeteer.protocol.page.windowopenevent.md) | Fired when a new window is going to be opened, via window.open(), link click, form submission, etc. |
|
|
|
|
## Type Aliases
|
|
|
|
| Type Alias | Description |
|
|
| --- | --- |
|
|
| [ClientNavigationDisposition](./puppeteer.protocol.page.clientnavigationdisposition.md) | |
|
|
| [ClientNavigationReason](./puppeteer.protocol.page.clientnavigationreason.md) | |
|
|
| [DialogType](./puppeteer.protocol.page.dialogtype.md) | Javascript dialog type. |
|
|
| [FrameId](./puppeteer.protocol.page.frameid.md) | Unique frame identifier. |
|
|
| [ReferrerPolicy](./puppeteer.protocol.page.referrerpolicy.md) | The referring-policy used for the navigation. |
|
|
| [ScriptIdentifier](./puppeteer.protocol.page.scriptidentifier.md) | Unique script identifier. |
|
|
| [TransitionType](./puppeteer.protocol.page.transitiontype.md) | Transition type. |
|
|
|