ManagerZones

Access this instance at HomeyAPIV3Local.zones.

Extends

  • HomeyAPIV3.ManagerZones

Classes

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
name
string
icon
string
parent
string
}
}

Returns

deleteZone

(async) deleteZone(opts)

Scopes

homey.zone

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

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
}

Returns

getZones

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

Scopes

homey.zone.readonly

HTTP

GET /api/manager/zones/zone

Returns

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
zone
object
name
string <optional>
icon
string <optional>
parent
string <optional>
}
}

Returns

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