system.user.addHoliday

This feature is new in Ignition version 7.8.0
Click here to check out the other new features

Description

Allows a holiday to be added.

Syntax

Parameters

HolidayModel holiday - The holiday to add.

Returns

UIResponse - an object with lists of warnings, errors, and info about the success or failure of the add.

Scope

All

Code Examples

Code Snippet

# This example adds a holiday
def printResponse(responseList):
    if len(responseList) > 0:
        for response in responseList:
            print "", response
    else:
        print " None"

from com.inductiveautomation.ignition.common.user.schedule import HolidayModel
from java.util import Date
holidayName = "Groundhog Day"
d = Date(2016 - 1900, 2, 2)			# java dates start in 1900
repeatAnnually = False
myHoliday = HolidayModel(holidayName, d, repeatAnnually)
response = system.user.addHoliday(myHoliday)
	
warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)
	 
errors = response.getErrors()
print "Errors are:"
printResponse(errors)
	 
infos = response.getInfos()
print "Infos are:"
printResponse(infos)

Output

Warnings are:
 None
Errors are:
 None
Infos are:
 New holiday "Groundhog Day" added.

Space shortcuts

Contents

Partner Programs

Resources

All Manual Versions