system.nav.getCurrentWindow

This function is used in Python Scripting.

Description

Returns the path of the current "main screen" window, which is defined as the maximized window. With the Typical Navigation Strategy, there is only ever one maximized window at a time.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.nav.getCurrentWindow()

Parameters

None

Returns

String - The path of the current "main screen" window - the maximized window.

Scope

Client

Code Examples

Code Snippet

# This code could run in a global timer script.
# After a 5-minute timeout, navigate back to the home screen
if system.util.getInactivitySeconds()>300 and system.nav.getCurrentWindow()!="Home":
   system.nav.swapTo("Home")