Class ESPRMNeoSchedule

constructor

• new ESPRMNeoSchedule(
      schedule: ScheduleItem,
      nodeId: string,
      groupId: string,
      id?: string,
      node?: ESPRMNeoNode,
      group?: ESPRMNeoGroup,
  ): ESPRMNeoSchedule

  Parameters

  • schedule: ScheduleItem
  • nodeId: string
  • groupId: string
  • Optionalid: string
  • Optionalnode: ESPRMNeoNode
  • Optionalgroup: ESPRMNeoGroup

  Returns ESPRMNeoSchedule

action

enabled

groupId

id

Optionalname

nodeId

triggers

Optionalvalidity

delete

• delete(): Promise<ESPAPIResponse>

  Deletes this schedule.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the schedule is successfully deleted.

  Throws

  If the node is not found.

  Throws

  If deletion fails or the API request fails.

enable

• enable(enabled: boolean): Promise<ESPAPIResponse>

  Enables or disables this schedule.

  Parameters

  • enabled: boolean

    true to enable the schedule, false to disable it.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the change succeeds.

  Throws

  If the node or schedule is not found.

  Throws

  If the update fails or the API request fails.

getNode

• getNode(): Promise<null | ESPRMNeoNode>

  Gets the node instance for this schedule. Returns the direct node reference when set, otherwise resolves it via the group. Returns null when neither path yields a node.

  Returns Promise<null | ESPRMNeoNode>

update

• update(updates: Partial<ScheduleItem>): Promise<ESPAPIResponse>

  Updates this schedule with partial changes.

  Parameters

  • updates: Partial<ScheduleItem>

    Partial schedule data containing fields to update.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the schedule is successfully updated.

  Throws

  If the node or schedule is not found.

  Throws

  If the update fails or the API request fails.