mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
f07ad2c661
This PR updates the docs regarding configuring puppeteer. In addition, some changes have been made to the documentation generator to show default values on the documentation site. Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
997 B
997 B
| sidebar_label |
|---|
| Page.emulateIdleState |
Page.emulateIdleState() method
Emulates the idle state. If no arguments set, clears idle state emulation.
Signature:
class Page {
emulateIdleState(overrides?: {
isUserActive: boolean;
isScreenUnlocked: boolean;
}): Promise<void>;
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | (Optional) Mock idle state. If not set, clears idle overrides |
Returns:
Promise<void>
Example
// set idle emulation
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
// do some checks here
...
// clear idle emulation
await page.emulateIdleState();