PageClient Methods |
The PageClient type exposes the following members.
Name | Description | |
---|---|---|
AddCompilationCacheAsync |
Seeds compilation cache for given url. Compilation cache does not survive
cross-process navigation.
| |
AddScriptToEvaluateOnNewDocumentAsync |
Evaluates given script in every frame upon creation (before loading frame's scripts).
| |
BringToFrontAsync |
Brings page to front (activates tab).
| |
CaptureScreenshotAsync |
Capture page screenshot.
| |
CaptureSnapshotAsync |
Returns a snapshot of the page as a string. For MHTML format, the serialization includes
iframes, shadow DOM, external resources, and element-inline styles.
| |
ClearCompilationCacheAsync |
Clears seeded compilation cache.
| |
CloseAsync |
Tries to close page, running its beforeunload hooks, if any.
| |
CrashAsync |
Crashes renderer on the IO thread, generates minidumps.
| |
CreateIsolatedWorldAsync |
Creates an isolated world for the given frame.
| |
DisableAsync |
Disables page domain notifications.
| |
EnableAsync |
Enables page domain notifications.
| |
EnumToString(ContentEncoding) | (Inherited from DevToolsDomainBase.) | |
EnumToString(CSPViolationType) | (Inherited from DevToolsDomainBase.) | |
EnumToString(DisabledImageType) | (Inherited from DevToolsDomainBase.) | |
EnumToString(Enum) | (Inherited from DevToolsDomainBase.) | |
EnumToString(PermissionType) | (Inherited from DevToolsDomainBase.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GenerateTestReportAsync |
Generates a report for testing.
| |
GetAdScriptIdAsync |
GetAdScriptId
| |
GetAppIdAsync |
Returns the unique (PWA) app id.
Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
| |
GetAppManifestAsync |
GetAppManifest
| |
GetFrameTreeAsync |
Returns present frame tree structure.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetInstallabilityErrorsAsync |
GetInstallabilityErrors
| |
GetLayoutMetricsAsync |
Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
| |
GetNavigationHistoryAsync |
Returns navigation history for the current page.
| |
GetOriginTrialsAsync |
Get Origin Trials on given frame.
| |
GetPermissionsPolicyStateAsync |
Get Permissions Policy state on given frame.
| |
GetResourceContentAsync |
Returns content of the given resource.
| |
GetResourceTreeAsync |
Returns present frame / resource tree structure.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HandleJavaScriptDialogAsync |
Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NavigateAsync |
Navigates current page to the given URL.
| |
NavigateToHistoryEntryAsync |
Navigates current page to the given history entry.
| |
PrintToPDFAsync |
Print page as PDF.
| |
ProduceCompilationCacheAsync |
Requests backend to produce compilation cache for the specified scripts.
`scripts` are appeneded to the list of scripts for which the cache
would be produced. The list may be reset during page navigation.
When script with a matching URL is encountered, the cache is optionally
produced upon backend discretion, based on internal heuristics.
See also: `Page.compilationCacheProduced`.
| |
ReloadAsync |
Reloads given page optionally ignoring the cache.
| |
RemoveScriptToEvaluateOnNewDocumentAsync |
Removes given script from the list.
| |
ResetNavigationHistoryAsync |
Resets navigation history for the current page.
| |
ScreencastFrameAckAsync |
Acknowledges that a screencast frame has been received by the frontend.
| |
SearchInResourceAsync |
Searches for given string in resource content.
| |
SetAdBlockingEnabledAsync |
Enable Chrome's experimental ad filter on all sites.
| |
SetBypassCSPAsync |
Enable page Content Security Policy by-passing.
| |
SetDocumentContentAsync |
Sets given markup as the document's HTML.
| |
SetFontFamiliesAsync |
Set generic font families.
| |
SetFontSizesAsync |
Set default font sizes.
| |
SetInterceptFileChooserDialogAsync |
Intercept file chooser requests and transfer control to protocol clients.
When file chooser interception is enabled, native file chooser dialog is not shown.
Instead, a protocol event `Page.fileChooserOpened` is emitted.
| |
SetLifecycleEventsEnabledAsync |
Controls whether page will emit lifecycle events.
| |
SetPrerenderingAllowedAsync |
Enable/disable prerendering manually.
This command is a short-term solution for https://crbug.com/1440085.
See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA
for more details.
TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.
| |
SetRPHRegistrationModeAsync |
Extensions for Custom Handlers API:
https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
| |
SetSPCTransactionModeAsync |
Sets the Secure Payment Confirmation transaction mode.
https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
| |
SetWebLifecycleStateAsync |
Tries to update the web lifecycle state of the page.
It will transition the page to the given state according to:
https://github.com/WICG/web-lifecycle/
| |
StartScreencastAsync |
Starts sending each frame using the `screencastFrame` event.
| |
StopLoadingAsync |
Force the page stop all navigations and pending resource fetches.
| |
StopScreencastAsync |
Stops sending each frame in the `screencastFrame`.
| |
ToBase64String | (Inherited from DevToolsDomainBase.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
WaitForDebuggerAsync |
Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
|