Skip to main content
Version: 23.10.0

Page.emulateIdleState() method

Emulates the idle state. If no arguments set, clears idle state emulation.

Signature

class Page {
abstract 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();