system.user.isUserScheduled

New in 7.9.7

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

Type	Parameter	Description
User	user	The user object to check the schedule for.
Date / Long	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

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

Scope

Gateway, Designer, Client

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"