system.vision.logout

Backwards Compatibility

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

Logs out of the Client for the current user and brings the Client to the login screen.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.logout()

Parameters

Nothing

Returns

Nothing

Scope

All

Code Example

Code Snippet

# This would run in a timer script to log the user out after 30 seconds of inactivity.
if system.vision.getInactivitySeconds() > 30:
   system.vision.logout()