Class default

Schedule - Manages schedule operations

This class handles all schedule-related operations including:

Schedule CRUD operations (Create, Read, Update, Delete)
Schedule enable/disable functionality
Schedule transformation and payload generation
Node-specific schedule operations

Schedule

Implements

Implements

Schedule

Index

Constructors

constructor

new default(schedule: default, rootStore: CDF): default
Creates a new Schedule instance

Initializes a schedule with the provided data and sets up the necessary operations and bindings. The schedule is linked to the root store for accessing other stores and services.
Parameters
- schedule: default
  The schedule data to initialize with
- rootStore: CDF
  Reference to the root CDF store
Returns default
Example
```
const schedule = new Schedule({
  id: 'schedule123',
  name: 'Morning Schedule',
  nodes: ['node1'],
  action: { node1: { light: { power: true } } }
  triggers: [{ m: 30, d: 1 }]
}, rootStore);
```
- Defined in src/impls/Schedule.ts:85

Properties

action

action: ScheduleAction

add

add: () => Promise<undefined | ESPAPIResponse | MultiNodeResponsePayload[]>

callbackUpdateOperation

callbackUpdateOperation: { [key: string]: ScheduleOperation }

devicesCount

devicesCount: number

disable

disable: () => Promise<undefined | ESPAPIResponse | MultiNodeResponsePayload[]>

edit

edit: (
__namedParameters: ScheduleEditParams,
) => Promise<undefined | ESPAPIResponse | MultiNodeResponsePayload[]>

enable

enable: () => Promise<undefined | ESPAPIResponse | MultiNodeResponsePayload[]>

`Optional`enabled

enabled?: boolean

`Optional`flags

flags?: null | number

`Readonly`id

id: string

`Optional`info

info?: null | string

name

name: string

nodes

nodes: string[]

outOfSyncMeta

outOfSyncMeta: Record<string, any>

remove

remove: () => Promise<undefined | ESPAPIResponse | MultiNodeResponsePayload[]>

triggers

triggers: ScheduleTrigger[]

`Optional`validity

validity?: null | { end: number; start: number }

Methods

addOutOfSyncMeta

addOutOfSyncMeta(nodeId: string, value: any): void
Adds out-of-sync metadata for a specific node

This method stores metadata indicating that a node's schedule configuration is not synchronized with the server state.
Parameters
- nodeId: string
  The identifier of the node
- value: any
  The metadata value to store
Returns void
Example
```
schedule.addOutOfSyncMeta('node1', { lastSync: timestamp });
```
- Defined in src/impls/Schedule.ts:596

clearOutOfSyncMeta

clearOutOfSyncMeta(): void
Clears all out-of-sync metadata

This method removes all stored metadata about node synchronization status, effectively marking all nodes as synchronized.

Returns void
Example
```
schedule.clearOutOfSyncMeta();
```
- Defined in src/impls/Schedule.ts:637

getOutOfSyncMeta

getOutOfSyncMeta(nodeId: string): any
Retrieves out-of-sync metadata for a specific node
Parameters
- nodeId: string
  The identifier of the node
Returns any
The stored metadata for the node
Example
```
const syncStatus = schedule.getOutOfSyncMeta('node1');
```
- Defined in src/impls/Schedule.ts:609

isEnabled

isEnabled(): boolean
Checks if the schedule is enabled

Returns boolean
True if the schedule is enabled, false otherwise
- Defined in src/impls/Schedule.ts:576

removeOutOfSyncMeta

removeOutOfSyncMeta(nodeId: string): void
Removes out-of-sync metadata for a specific node

This method clears the stored metadata indicating that a node's schedule configuration has been synchronized.
Parameters
- nodeId: string
  The identifier of the node
Returns void
Example
```
schedule.removeOutOfSyncMeta('node1');
```
- Defined in src/impls/Schedule.ts:624

validateSchedule

validateSchedule(__namedParameters: default): void
Parameters
- __namedParameters: default
Returns void
- Defined in src/impls/Schedule.ts:641