Schedule

public struct Schedule : Decodable

Describes a schedule and it’s configuration

  • Describes the command to execute when the scheduled event occurs.

    See more

    Declaration

    Swift

    public struct Command : Decodable

  • Name for the new schedule. If a name is not specified then the default name, “schedule”, is used. If the name is already taken a space and number will be appended by the bridge, e.g. “schedule 1”.

    Declaration

    Swift

    public let name: String

  • Description of the new schedule. If the description is not specified it will be empty.

    Declaration

    Swift

    public let description: String

  • Time when the scheduled event will occur. Time is measured in the bridge in UTC time. Either time or localtime has to be provided. DEPRECATED: This attribute will be removed in the future. Please use localtime instead.

    • The following time patterns are allowed:
    • Absolute time
    • Randomized time
    • Recurring times
    • Recurring randomized times
    • Timers

    Declaration

    Swift

    public let time: String

  • Undocumented

    Declaration

    Swift

    public let created: String

  • Application is only allowed to set “enabled” or “disabled”. Disabled causes a timer to reset when activated (i.e. stop & reset). “enabled” when not provided on creation.

    Declaration

    Swift

    public let status: String

  • Command to execute when the scheduled event occurs. If the command is not valid then an error of type 7 will be raised.

    Declaration

    Swift

    public let command: Command

  • When true: Resource is automatically deleted when not referenced anymore in any resource link. Only on creation of resource. “false” when omitted.

    Declaration

    Swift

    public let recycle: Bool

  • Local time when the scheduled event will occur.Either time or localtime has to be provided. A schedule configured with localtime will operate on localtime and is returned along with the time attribute (UTC) for backwards compatibility.

    Declaration

    Swift

    public let localTime: String