puppeteer/website/versioned_docs/version-20.7.0/api/puppeteer.page.emulateidlestate.md

42 lines
982 B
Markdown
Raw Normal View History

---
sidebar_label: Page.emulateIdleState
---
# Page.emulateIdleState() method
Emulates the idle state. If no arguments set, clears idle state emulation.
2022-10-24 14:31:12 +00:00
#### Signature:
```typescript
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&lt;void&gt;
## Example
```ts
// set idle emulation
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
// do some checks here
...
// clear idle emulation
await page.emulateIdleState();
```