mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
93e9acc410
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Nikolay Vitkov <nvitkov@chromium.org>
65 lines
885 B
Markdown
65 lines
885 B
Markdown
---
|
|
sidebar_label: Page.emulateIdleState
|
|
---
|
|
|
|
# Page.emulateIdleState() method
|
|
|
|
Emulates the idle state. If no arguments set, clears idle state emulation.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Page {
|
|
abstract emulateIdleState(overrides?: {
|
|
isUserActive: boolean;
|
|
isScreenUnlocked: boolean;
|
|
}): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
overrides
|
|
|
|
</td><td>
|
|
|
|
{ isUserActive: boolean; isScreenUnlocked: boolean; }
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Mock idle state. If not set, clears idle overrides
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
**Returns:**
|
|
|
|
Promise<void>
|
|
|
|
## Example
|
|
|
|
```ts
|
|
// set idle emulation
|
|
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
|
|
|
|
// do some checks here
|
|
...
|
|
|
|
// clear idle emulation
|
|
await page.emulateIdleState();
|
|
```
|