Skip to main content
Version: 8.1

system.user.getScheduledUsers

This function is used in Python Scripting.

Description​

Returns a list of users that are scheduled. If no users are scheduled, it will return an empty list.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.user.getScheduledUsers(userSource, [date])

Parameters​

TypeParameterDescription
StringuserSourceThe name of the user source to check for scheduled users.
DatedateThe date to check schedules for. May be a Java Date or Unix Time in ms. If omitted, the current date and time will be used. [optional]

Returns​

List - List of all Users (as User objects) scheduled for the given date, taking schedule adjustments into account. Refer also to the PyUser class.

Scope​

Gateway, Vision Client, Perspective Session

Code Examples​

Example #1
# Get all users scheduled for the date specified in a popup calendar and print their names.
 
date = event.source.parent.getComponent('Popup Calendar').date
users = system.user.getScheduledUsers("default", date)
 
if users == None:
    print "No users scheduled"
else:
    print "Scheduled users:"
    for user in users:
        print user.get(user.Username)