system.vision.lockScreen

Backwards Compatibility

This function replaces system.security.lockScreen. 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

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.vision.unlockScreen() function.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.lockScreen([obscure])

Parameters

Type	Parameter	Description
Boolean	obscure	If true(1), the locked screen will be opaque, otherwise it will be partially visible. [optional]

Returns

Nothing

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