ManagerExperiments

Access this instance at HomeyAPIV3Local.experiments.

Extends

Classes

Methods

connect

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

Connect to the realtime namespace.

Returns

Promise.<void>

disableExperiment

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

Scopes

-

HTTP

PUT /api/manager/experiments/experiment/:experimentId/disable

Parameters

Name Type Description
opts
object
experimentId
string
}

Returns

Promise.<any>

disconnect

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

Disconnect from the realtime namespace.

Returns

Promise.<void>

enableExperiment

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

Scopes

-

HTTP

PUT /api/manager/experiments/experiment/:experimentId/enable

Parameters

Name Type Description
opts
object
experimentId
string
}

Returns

Promise.<any>

getExperiments

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

Scopes

-

HTTP

GET /api/manager/experiments/experiment

Returns

Promise.<any>

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/experiments/state

Returns

Promise.<any>

isConnected

isConnected(): Boolean

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

Returns

Boolean

Events

experiment-homekit.create

.on('experiment-homekit.create')

Parameters

Name Type Description
experiment-homekit
HomeyAPIV3Local.ManagerExperiments.ExperimentHomeKit

experiment-homekit.delete

.on('experiment-homekit.delete')

Parameters

Name Type Description
experiment-homekit
HomeyAPIV3Local.ManagerExperiments.ExperimentHomeKit

experiment-homekit.update

.on('experiment-homekit.update')

Parameters

Name Type Description
experiment-homekit
HomeyAPIV3Local.ManagerExperiments.ExperimentHomeKit

experiment-poweruser.create

.on('experiment-poweruser.create')

Parameters

Name Type Description
experiment-poweruser
HomeyAPIV3Local.ManagerExperiments.ExperimentPowerUser

experiment-poweruser.delete

.on('experiment-poweruser.delete')

Parameters

Name Type Description
experiment-poweruser
HomeyAPIV3Local.ManagerExperiments.ExperimentPowerUser

experiment-poweruser.update

.on('experiment-poweruser.update')

Parameters

Name Type Description
experiment-poweruser
HomeyAPIV3Local.ManagerExperiments.ExperimentPowerUser

experiment-ssh.create

.on('experiment-ssh.create')

Parameters

Name Type Description
experiment-ssh
HomeyAPIV3Local.ManagerExperiments.ExperimentSSH

experiment-ssh.delete

.on('experiment-ssh.delete')

Parameters

Name Type Description
experiment-ssh
HomeyAPIV3Local.ManagerExperiments.ExperimentSSH

experiment-ssh.update

.on('experiment-ssh.update')

Parameters

Name Type Description
experiment-ssh
HomeyAPIV3Local.ManagerExperiments.ExperimentSSH

experiment-virtualdevices.create

.on('experiment-virtualdevices.create')

Parameters

Name Type Description
experiment-virtualdevices
HomeyAPIV3Local.ManagerExperiments.ExperimentVirtualDevices

experiment-virtualdevices.delete

.on('experiment-virtualdevices.delete')

Parameters

Name Type Description
experiment-virtualdevices
HomeyAPIV3Local.ManagerExperiments.ExperimentVirtualDevices

experiment-virtualdevices.update

.on('experiment-virtualdevices.update')

Parameters

Name Type Description
experiment-virtualdevices
HomeyAPIV3Local.ManagerExperiments.ExperimentVirtualDevices