system.vision.getRoles

Backwards Compatibility

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

Finds the roles that the currently logged in user has, returns them as a Python tuple of strings.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.getRoles()

Parameters

Nothing

Returns

Tuple - A list of the roles (strings) that are assigned to the current user.

Scope

Vision Client

Code Examples

Example #1

# This would run on a button to prevent certain users from opening a window
  
if "Supervisor" in system.vision.getRoles():
   system.vision.openWindow("ManagementOnly")
else:
   system.vision.showError("You don't have sufficient privileges to continue")