Access this instance at HomeyAPIV3Cloud.moods.
Extends
- HomeyAPIV3.ManagerMoods
Classes
Instance Methods
createMood
(async) createMood(opts): Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>Scopes
homey.mood
HTTP
POST /api/manager/moods/mood
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
mood
|
object | In |
name
|
string | |
devices
|
object | |
preset
|
string
<optional> |
|
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>
deleteMood
(async) deleteMood(opts)Scopes
homey.mood
HTTP
DELETE /api/manager/moods/mood/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
|
|
getMood
(async) getMood(opts): Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>Scopes
homey.mood.readonly
HTTP
GET /api/manager/moods/mood/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>
getMoods
(async) getMoods(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerMoods.Mood>>Scopes
homey.mood.readonly
HTTP
GET /api/manager/moods/mood
Returns
Promise.<Object.<string, HomeyAPIV3Cloud.ManagerMoods.Mood>>
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/moods/state
Returns
Promise.<any>
setMood
(async) setMood(opts): Promise.<any>Scopes
homey.mood.set
HTTP
POST /api/manager/moods/mood/:id/set
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
|
|
Returns
Promise.<any>
updateMood
(async) updateMood(opts): Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>Scopes
homey.mood
HTTP
PUT /api/manager/moods/mood/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
mood
|
object | In |
name
|
string
<optional> |
|
devices
|
object
<optional> |
|
preset
|
string
<optional> |
|
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerMoods.Mood>
Events
mood.create
.on('mood.create')Parameters
| Name | Type | Description |
|---|---|---|
mood
|
HomeyAPIV3Cloud.ManagerMoods.Mood |
mood.delete
.on('mood.delete')Parameters
| Name | Type | Description |
|---|---|---|
mood
|
HomeyAPIV3Cloud.ManagerMoods.Mood |
mood.update
.on('mood.update')Parameters
| Name | Type | Description |
|---|---|---|
mood
|
HomeyAPIV3Cloud.ManagerMoods.Mood | |
info
|
object | |
newValues
|
object | An object with only the new values of the mood |
oldValues
|
object | An object with only the old values of the mood |
changedKeys
|
Array.<string> | An array of keys of the properties that have changed |
|
|