Skip to content

Latest commit

 

History

History
134 lines (122 loc) · 12 KB

puppeteer.protocol.page.md

File metadata and controls

134 lines (122 loc) · 12 KB

Home > puppeteer > Protocol > Page

Protocol.Page namespace

Actions and events related to the inspected page belong to the page domain.

Signature:

export namespace Page 

Enumerations

Enumeration Description
CaptureScreenshotRequestFormat
CaptureSnapshotRequestFormat
DownloadProgressEventState
FileChooserOpenedEventMode
PrintToPDFRequestTransferMode
SetDownloadBehaviorRequestBehavior
SetTouchEmulationEnabledRequestConfiguration
SetWebLifecycleStateRequestState
StartScreencastRequestFormat

Interfaces

Interface Description
AddCompilationCacheRequest
AddScriptToEvaluateOnLoadRequest
AddScriptToEvaluateOnLoadResponse
AddScriptToEvaluateOnNewDocumentRequest
AddScriptToEvaluateOnNewDocumentResponse
AppManifestError Error while paring app manifest.
AppManifestParsedProperties Parsed app manifest properties.
CaptureScreenshotRequest
CaptureScreenshotResponse
CaptureSnapshotRequest
CaptureSnapshotResponse
CompilationCacheProducedEvent Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.
CreateIsolatedWorldRequest
CreateIsolatedWorldResponse
DeleteCookieRequest
DomContentEventFiredEvent
DownloadProgressEvent Fired when download makes progress. Last call has |done| == true.
DownloadWillBeginEvent Fired when page is about to start a download.
FileChooserOpenedEvent Emitted only when page.interceptFileChooser is enabled.
FontFamilies Generic font families collection.
FontSizes Default font sizes.
Frame Information about the Frame on the page.
FrameAttachedEvent Fired when frame has been attached to its parent.
FrameClearedScheduledNavigationEvent Fired when frame no longer has a scheduled navigation.
FrameDetachedEvent Fired when frame has been detached from its parent.
FrameNavigatedEvent Fired once navigation of the frame has completed. Frame is now associated with the new loader.
FrameRequestedNavigationEvent Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.
FrameResource Information about the Resource on the page.
FrameResourceTree Information about the Frame hierarchy along with their cached resources.
FrameScheduledNavigationEvent Fired when frame schedules a potential navigation.
FrameStartedLoadingEvent Fired when frame has started loading.
FrameStoppedLoadingEvent Fired when frame has stopped loading.
FrameTree Information about the Frame hierarchy.
GenerateTestReportRequest
GetAppManifestResponse
GetCookiesResponse
GetFrameTreeResponse
GetInstallabilityErrorsResponse
GetLayoutMetricsResponse
GetManifestIconsResponse
GetNavigationHistoryResponse
GetResourceContentRequest
GetResourceContentResponse
GetResourceTreeResponse
HandleJavaScriptDialogRequest
InstallabilityError The installability error
InstallabilityErrorArgument
JavascriptDialogClosedEvent Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.
JavascriptDialogOpeningEvent Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.
LayoutViewport Layout viewport position and dimensions.
LifecycleEventEvent Fired for top level page lifecycle events such as navigation, load, paint, etc.
LoadEventFiredEvent
NavigatedWithinDocumentEvent Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
NavigateRequest
NavigateResponse
NavigateToHistoryEntryRequest
NavigationEntry Navigation history entry.
PrintToPDFRequest
PrintToPDFResponse
ReloadRequest
RemoveScriptToEvaluateOnLoadRequest
RemoveScriptToEvaluateOnNewDocumentRequest
ScreencastFrameAckRequest
ScreencastFrameEvent Compressed image data requested by the startScreencast.
ScreencastFrameMetadata Screencast frame metadata.
ScreencastVisibilityChangedEvent Fired when the page with currently enabled screencast was shown or hidden `.
SearchInResourceRequest
SearchInResourceResponse
SetAdBlockingEnabledRequest
SetBypassCSPRequest
SetDeviceMetricsOverrideRequest
SetDeviceOrientationOverrideRequest
SetDocumentContentRequest
SetDownloadBehaviorRequest
SetFontFamiliesRequest
SetFontSizesRequest
SetGeolocationOverrideRequest
SetInterceptFileChooserDialogRequest
SetLifecycleEventsEnabledRequest
SetProduceCompilationCacheRequest
SetTouchEmulationEnabledRequest
SetWebLifecycleStateRequest
StartScreencastRequest
Viewport Viewport for capturing screenshot.
VisualViewport Visual viewport position, dimensions, and scale.
WindowOpenEvent Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

Type Aliases

Type Alias Description
AdFrameType Indicates whether a frame has been identified as an ad.
ClientNavigationDisposition
ClientNavigationReason
CrossOriginIsolatedContextType Indicates whether the frame is cross-origin isolated and why it is the case.
DialogType Javascript dialog type.
FrameId Unique frame identifier.
ReferrerPolicy The referring-policy used for the navigation.
ScriptIdentifier Unique script identifier.
SecureContextType Indicates whether the frame is a secure context and why it is the case.
TransitionType Transition type.