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

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

// set idle emulation
await page.emulateIdleState({isUserActive: true, isScreenUnlocked: false});

// do some checks here
...

// clear idle emulation
await page.emulateIdleState();