system.security.lockScreen

Description

Used to put a running client in lock-screen mode. The screen can be unlocked by the user with the proper credentials, or by scripting via the system.security.unlockScreen() function.

Syntax

system.security. lockScreen( [obscure] )

  • Parameters

boolean obscure - If true(1), the locked screen will be opaque, otherwise it will be partially visible. [optional]

  • Returns

nothing

  • Scope

Client

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()