ManagerZones - Homey Web API

Access this instance at HomeyAPIV3Local.zones.

Extends

HomeyAPIV3.ManagerZones

Classes

Zone

Instance Methods

createZone

(async) createZone(opts): Promise.<HomeyAPIV3Local.ManagerZones.Zone>

Scopes

homey.zone

HTTP

POST /api/manager/zones/zone

Parameters

Name	Type	Description
`opts`	object
`zone`	object	In `body`
`name`	string
`icon`	string
`parent`	string
}
}

Returns

Promise.<HomeyAPIV3Local.ManagerZones.Zone>

deleteZone

(async) deleteZone(opts)

Scopes

homey.zone

HTTP

DELETE /api/manager/zones/zone/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

getState

(async) getState(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/zones/state

Returns

Promise.<any>

getZone

(async) getZone(opts): Promise.<HomeyAPIV3Local.ManagerZones.Zone>

Scopes

homey.zone.readonly

HTTP

GET /api/manager/zones/zone/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

Returns

Promise.<HomeyAPIV3Local.ManagerZones.Zone>

getZones

(async) getZones(): Promise.<Object.<string, HomeyAPIV3Local.ManagerZones.Zone>>

Scopes

homey.zone.readonly

HTTP

GET /api/manager/zones/zone

Returns

Promise.<Object.<string, HomeyAPIV3Local.ManagerZones.Zone>>

updateZone

(async) updateZone(opts): Promise.<HomeyAPIV3Local.ManagerZones.Zone>

Scopes

homey.zone

HTTP

PUT /api/manager/zones/zone/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`zone`	object	In `body`
`name`	string <optional>
`icon`	string <optional>
`parent`	string <optional>
}
}

Returns

Promise.<HomeyAPIV3Local.ManagerZones.Zone>

Events

zone.create

.on('zone.create')

Parameters

Name	Type	Description
`zone`	HomeyAPIV3Local.ManagerZones.Zone

zone.delete

.on('zone.delete')

Parameters

Name	Type	Description
`zone`	HomeyAPIV3Local.ManagerZones.Zone

zone.update

.on('zone.update')

Parameters

Name	Type	Description
`zone`	HomeyAPIV3Local.ManagerZones.Zone
`info`	object
`newValues`	object	An object with only the new values of the zone
`oldValues`	object	An object with only the old values of the zone
`changedKeys`	Array.<string>	An array of keys of the properties that have changed
}