In the IOM, all schedules are derived from a common Schedule base class. This base contains all the shared components of schedules.

All schedules will inherit properties from the Schedule base class.

Like other high-level objects in Indigo, there are rules for modifying schedules. For Scripters and Plugin Developers:

1. To create, duplicate, delete, and send commands to a schedule, use the command namespace as described below
2. To modify an object's definition, get a copy of the schedule, make the necessary changes, then call mySchedule.replaceOnServer(newPropsDict)

For Plugin Developers:

1. To update a plugin's props on a schedule, call mySchedule.replacePluginPropsOnServer(newPropsDict) rather than try to update them on the local schedule

Unlike Devices, you can't call create() in the the schedule base class command namespace (indigo.schedule.*). Rather, each subclass has its own create() method that takes the appropriate arguments for that schedule type.

Under construction

Delete the specified schedule.

indigo.schedule.delete(123)

Duplicate the specified schedule regardless of the type. This method returns a copy of the new schedule.

indigo.schedule.duplicate(123, duplicateName="my duplicate name")

Enables or disables the specified schedule.

indigo.schedule.enable(123, value=True, delay=0, duration=0)

Execute the specified schedule.

indigo.schedule.execute(123, ignoreConditions=False, schedule_data=None)

A note on schedule_data - Indigo will automatically add a source key to your dictionary to represent where the action execution came from:

• “server” if it's something generated from the server itself (schedule execution, built-in trigger, etc)
• “python” if it's something that comes through IPH that doesn't already have a source attached (scripts, plugins)
• “api-http” if it came from the HTTP API and there wasn't already an included “source”
• “api-websocket” if it came from the websocket API and there wasn't already an included “source”

However, if you include a source key in your schedule_data, we will not overwrite it, we'll just pass through whatever your value is.

For example, if you

my_dict = indigo.Dict()
my_dict["foo"] = "bar"
indigo.schedule.execute(324976872, schedule_data=my_dict)

The schedule you executed will receive something like this:

{"event-indigo-id": 324976872, "event-type": "Schedule", "foo": "bar", "source": "python", "timestamp": "1970-01-01T09:09:40"}

Get the dependencies of the specified schedule. Returns an indigo.Dict object that contains the schedule's dependencies. Will return an empty indigo.Dict object if the schedule has no dependencies.

indigo.schedule.getDependencies(123)

Move the specified schedule to the designated folder.

indigo.schedule.moveToFolder(123, value=)

Remove any outstanding delayed actions from the specified schedule.

indigo.schedule.removeDelayedActions(123)