Zone

Zone as returned by HomeyAPIV3Cloud.ManagerZones.

Extends

Instance Properties

active

active: boolean

Type

  • boolean

activeLastUpdated

activeLastUpdated: string|null

Type

  • string | null

activeOrigins

activeOrigins: array

Type

  • array

homey

homey: HomeyAPIV3

The Homey of the Item.

Type

icon

icon: string

Type

  • string

id

id: string

Type

  • string

manager

manager: HomeyAPIV3.Manager

The Manager of the Item.

Type

name

name: string

Type

  • string

parent

parent: string|null

Type

  • string | null

uri

uri: string

The URI of the Item, e.g. homey:foo:bar.

Type

  • string

Instance Methods

connect

(async) connect()

Connect to this item's Socket.io namespace.

disconnect

(async) disconnect()

Discconnect from this item's Socket.io namespace.

getParent

(async) getParent(): Promise.<(HomeyAPIV3.ManagerZones.Zone|null)>

Get the parent zone.

Returns

Promise.<(HomeyAPIV3.ManagerZones.Zone|null)>

Events

delete

.on('delete')

update

.on('update')

Parameters

Name Type Description
zone 		object
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
}