Skip to main content
Version: 8.3 Beta 🚧

system.vision.isScreenLocked

Backwards Compatibility

This function replaces system.security.isScreenLocked. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description​

Returns whether or not the screen is currently locked.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.vision.isScreenLocked()

Parameters​

Nothing

Returns​

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

Scope​

Vision Client

Code Example​

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.vision.getInactivitySeconds() > 15 and not system.vision.isScreenLocked():
   system.vision.lockScreen()
elif system.vision.getInactivitySeconds() > 30:
   system.vision.logout()