Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


New_in
Version7.9.7



Scripting_function



Panel
titleDescription

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


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

system.user.getScheduledUsers(userSource, date)

  • Parameters

String userSource - The name of the user source to check for scheduled users.

Date date - The 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 scheduled for the given date, taking schedule adjustments into account.

  • Scope

All



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet
# 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)