Class ESPCDFSchedule

constructor

• new ESPCDFSchedule(scheduleData: ESPCDFScheduleInterface): ESPCDFSchedule

  Parameters

  • scheduleData: ESPCDFScheduleInterface

  Returns ESPCDFSchedule

_raw

action

OptionaladaptorIdentifier

devicesCount

Optionalenabled

Readonlyevents

Optionalflags

id

Optionalinfo

name

nodes

operations

OptionaloutOfSyncMeta

triggers

Optionalvalidity

add

• add(): Promise<ESPCDFAPIResponse<any>>

  Returns Promise<ESPCDFAPIResponse<any>>

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 });
  Copy

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();
  Copy

disable

• disable(): Promise<ESPCDFAPIResponse<any>>

  Returns Promise<ESPCDFAPIResponse<any>>

dispose

• dispose(): void

  Remove all listeners and clean up

  Returns void

edit

• edit(data: ESPCDFScheduleEditInput): Promise<ESPCDFAPIResponse<any>>

  Parameters

  • data: ESPCDFScheduleEditInput

  Returns Promise<ESPCDFAPIResponse<any>>

enable

• enable(): Promise<ESPCDFAPIResponse<any>>

  Returns Promise<ESPCDFAPIResponse<any>>

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');
  Copy

isEnabled

• isEnabled(): boolean

  Checks if the schedule is enabled

  Returns boolean

  True if the schedule is enabled, false otherwise

remove

• remove(): Promise<ESPCDFAPIResponse<any>>

  Returns Promise<ESPCDFAPIResponse<any>>

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');
  Copy

subscribe

• subscribe(
      listener: ESPCDFOperationListener<
          ESPCDFSchedule,
          ESPCDFScheduleOperationType,
      >,
  ): () => void

  Subscribe to all operation events

  Parameters

  • listener: ESPCDFOperationListener<ESPCDFSchedule, ESPCDFScheduleOperationType>

    The callback function to register

  Returns () => void

  Unsubscribe function