system.security.isScreenLocked

Description

Returns whether or not the screen is currently locked.

Syntax

system.security. isScreenLocked()

  • Parameters

none

  • Returns

boolean - A flag indicating whether or not the screen is currently locked.

  • Scope

All

Code Examples
Code Snippet
#This would run in a timer script to lock the screen after 15 seconds of inactivity, and then log the user out after 30 seconds of inactivity.
if system.util.getInactivitySeconds() > 15 and not system.security.isScreenLocked():
system.security.lockScreen()
elif system.util.getInactivitySeconds() > 30:
system.security.logout()