system.user

User Functions

The following functions give you access to view and edit users.

📄️ system.user.addHoliday

Adds a holiday.

📄️ system.user.addRole

Adds a role to the specified user source.

📄️ system.user.addSchedule

Adds a schedule.

📄️ system.user.editHoliday

Allows a holiday to be edited.

📄️ system.user.editRole

Renames a role in the specified user source.

📄️ system.user.editSchedule

Allows a schedule to be edited.

📄️ system.user.getHoliday

Returns a specific holiday.

📄️ system.user.getHolidayNames

Returns a collection of Strings of all holiday names.

📄️ system.user.getHolidays

Returns a sequence of all of the holidays available.

📄️ system.user.getRoles

Returns a sequence of strings representing all of the roles configured in a specific user source.

📄️ system.user.getSchedule

Returns a specific schedule.

📄️ system.user.getScheduledUsers

Returns a list of users that are scheduled on.

📄️ system.user.getScheduleNames

Returns a sequence of strings representing the names of all of the schedules available.

📄️ system.user.getSchedules

Returns a sequence of all available schedule models, which can be used to return configuration information on the schedule, such as time for each day of the week.

📄️ system.user.getUser

Looks up a specific user in a user source, by username.

📄️ system.user.getUsers

Retrieves the list of users in a specific user source.

📄️ system.user.isUserScheduled

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

📄️ system.user.removeHoliday

Allows a holiday to be deleted.

📄️ system.user.removeRole

Removes a role from the specified user source.

📄️ system.user.removeSchedule

Allows a schedule to be deleted.

Functions by Scope

No functions found for this category.