43 lines
941 B
Markdown
43 lines
941 B
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [emulateIdleState](./puppeteer.page.emulateidlestate.md)
|
||
|
|
|
||
|
|
## Page.emulateIdleState() method
|
||
|
|
|
||
|
|
Emulates the idle state. If no arguments set, clears idle state emulation.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
emulateIdleState(overrides?: {
|
||
|
|
isUserActive: boolean;
|
||
|
|
isScreenUnlocked: boolean;
|
||
|
|
}): Promise<void>;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| overrides | { isUserActive: boolean; isScreenUnlocked: boolean; } | Mock idle state. If not set, clears idle overrides |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
Promise<void>
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
|
||
|
|
```js
|
||
|
|
// set idle emulation
|
||
|
|
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});
|
||
|
|
|
||
|
|
// do some checks here
|
||
|
|
...
|
||
|
|
|
||
|
|
// clear idle emulation
|
||
|
|
await page.emulateIdleState();
|
||
|
|
|
||
|
|
```
|
||
|
|
|