Skip to content

Class: Schedules ​

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:51

Constructors ​

Constructor ​

new Schedules(omni): Schedules

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:54

Parameters ​

omni ​

OmniLogic

Returns ​

Schedules

Methods ​

create() ​

create(spec, options?): Promise<Schedule>

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:70

Parameters ​

spec ​

ScheduleCreate

options? ​

WriteOptions = {}

Returns ​

Promise<Schedule>


for() ​

for(equipmentId): Schedule[]

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:62

Parameters ​

equipmentId ​

number

Returns ​

Schedule[]


get() ​

get(scheduleId): Schedule | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:66

Parameters ​

scheduleId ​

number

Returns ​

Schedule | undefined


list() ​

list(): Schedule[]

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:58

Returns ​

Schedule[]


remove() ​

remove(scheduleId, options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:153

Parameters ​

scheduleId ​

number

options? ​

WriteOptions = {}

Returns ​

Promise<void>


setEnabled() ​

setEnabled(scheduleId, enabled, options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:136

Parameters ​

scheduleId ​

number

enabled ​

boolean

options? ​

WriteOptions = {}

Returns ​

Promise<void>


update() ​

update(scheduleId, changes, options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/schedules.ts:102

Parameters ​

scheduleId ​

number

changes ​

ScheduleUpdate

options? ​

WriteOptions = {}

Returns ​

Promise<void>

This software is not produced, endorsed, or supported by Hayward Industries, Inc. “Hayward” and “OmniLogic” are trademarks of their respective owners.