puppeteer/docs/api/puppeteer.page.emulateidlestate.md

65 lines
885 B
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Page.emulateIdleState
---
# Page.emulateIdleState() method
Emulates the idle state. If no arguments set, clears idle state emulation.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Page {
abstract emulateIdleState(overrides?: {
2022-07-05 13:41:43 +00:00
isUserActive: boolean;
isScreenUnlocked: boolean;
}): Promise<void>;
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
overrides
</td><td>
&#123; isUserActive: boolean; isScreenUnlocked: boolean; &#125;
</td><td>
_(Optional)_ Mock idle state. If not set, clears idle overrides
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**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();
```