ManagerUpdates

Access this instance at HomeyAPIV2.updates.

Extends

Instance Properties

homey

homey: HomeyAPIV3

The Homey of the Manager.

Type

uri

uri: String

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

Type

  • String

Instance Methods

addListener

addListener(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

connect

(async) connect(): Promise.<void>

Connect to this manager's Socket.io namespace.

Returns

Promise.<void>

destroy

destroy()

Destroy this Manager by cleaning up all references, unbinding event listeners and disconnecting from the Socket.io namespace.

disconnect

(async) disconnect(): Promise.<void>

Disconnect from this manager's Socket.io namespace.

Returns

Promise.<void>

emit

emit(event, …data)

Parameters

Name Type Description
event 		string
data 		any <repeatable>

getOptionAutoupdate

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

Scopes

UPDATES_READONLY

HTTP

GET /api/manager/updates/option/autoupdate

Returns

Promise.<any>

getOptionChannel

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

Scopes

UPDATES_READONLY

HTTP

GET /api/manager/updates/option/channel

Returns

Promise.<any>

getOptionForceChannel

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

Scopes

UPDATES_READONLY

HTTP

GET /api/manager/updates/option/forceChannel

Returns

Promise.<any>

getOptionUpdateNotifications

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

Scopes

UPDATES_READONLY

HTTP

GET /api/manager/updates/option/updateNotifications

Returns

Promise.<any>

getState

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

Scopes

UPDATES_READONLY

HTTP

GET /api/manager/updates/state

Returns

Promise.<any>

getUpdates

(async) getUpdates(opts): Promise.<any>

Scopes

homey.updates.readonly

HTTP

GET /api/manager/updates/update

Parameters

Name Type Description
opts 		object
flags 		string <optional>
cache 		string <optional>
}

Returns

Promise.<any>

getWhatsNew

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

Scopes

homey.updates.readonly

HTTP

GET /api/manager/updates/whatsnew/

Returns

Promise.<any>

installUpdate

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

Scopes

homey.updates

HTTP

POST /api/manager/updates/update

Returns

Promise.<any>

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

off

off(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

on

on(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

once

once(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

removeAllListeners

removeAllListeners(event)

Parameters

Name Type Description
event 		string

removeListener

removeListener(event, callback)

Shortcut to EventEmitter#off

Parameters

Name Type Description
event 		string
callback 		function

setOptionAutoupdate

(async) setOptionAutoupdate(opts): Promise.<any>

Scopes

UPDATES

HTTP

PUT /api/manager/updates/option/autoupdate

Parameters

Name Type Description
opts 		object
value 		boolean
}

Returns

Promise.<any>

setOptionChannel

(async) setOptionChannel(opts): Promise.<any>

Scopes

UPDATES

HTTP

PUT /api/manager/updates/option/channel

Parameters

Name Type Description
opts 		object
value 		string
}

Returns

Promise.<any>

setOptionForceChannel

(async) setOptionForceChannel(opts): Promise.<any>

Scopes

UPDATES

HTTP

PUT /api/manager/updates/option/forceChannel

Parameters

Name Type Description
opts 		object
value 		string
}

Returns

Promise.<any>

setOptionUpdateNotifications

(async) setOptionUpdateNotifications(opts): Promise.<any>

Scopes

UPDATES

HTTP

PUT /api/manager/updates/option/updateNotifications

Parameters

Name Type Description
opts 		object
value 		array
}

Returns

Promise.<any>

setWhatsNewRead

(async) setWhatsNewRead(opts): Promise.<any>

Scopes

homey.updates.readonly

HTTP

DELETE /api/manager/updates/whatsnew/:id

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

unsetOptionAutoupdate

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

Scopes

UPDATES

HTTP

DELETE /api/manager/updates/option/autoupdate

Returns

Promise.<any>

unsetOptionChannel

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

Scopes

UPDATES

HTTP

DELETE /api/manager/updates/option/channel

Returns

Promise.<any>

unsetOptionForceChannel

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

Scopes

UPDATES

HTTP

DELETE /api/manager/updates/option/forceChannel

Returns

Promise.<any>

unsetOptionUpdateNotifications

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

Scopes

UPDATES

HTTP

DELETE /api/manager/updates/option/updateNotifications

Returns

Promise.<any>