Skip to main content
Version: 8.1

system.user.isUserScheduled

This function is used in Python Scripting.

Description

Will check if a specified User is scheduled currently or on a specified date/time.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.user.isUserScheduled(user, [date])

Parameters

TypeParameterDescription
UseruserThe user object to check the schedule for.
Date / IntegerdateThe 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

Boolean - True if the user is scheduled for the specified date; false if not.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# Print whether or not the user "oper1" is scheduled currently.

user = system.user.getUser("", "oper1")
if system.user.isUserScheduled(user):
print "oper1 is scheduled"
else:
print "oper1 is not scheduled"