ManagerMoods - Homey Web API

Access this instance at HomeyAPIV3Local.moods.

Extends

HomeyAPIV3.ManagerMoods

Classes

Mood

Instance Methods

createMood

(async) createMood(opts): Promise.<HomeyAPIV3Local.ManagerMoods.Mood>

Scopes

homey.mood

HTTP

POST /api/manager/moods/mood

Parameters

Name	Type	Description
`opts`	object
`mood`	object	In `body`
`name`	string
`devices`	object
`preset`	string <optional>
}
}

Returns

Promise.<HomeyAPIV3Local.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 `path`
}

getMood

(async) getMood(opts): Promise.<HomeyAPIV3Local.ManagerMoods.Mood>

Scopes

homey.mood.readonly

HTTP

GET /api/manager/moods/mood/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

Returns

Promise.<HomeyAPIV3Local.ManagerMoods.Mood>

getMoods

(async) getMoods(): Promise.<Object.<string, HomeyAPIV3Local.ManagerMoods.Mood>>

Scopes

homey.mood.readonly

HTTP

GET /api/manager/moods/mood

Returns

Promise.<Object.<string, HomeyAPIV3Local.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 `path`
}

Returns

Promise.<any>

updateMood

(async) updateMood(opts): Promise.<HomeyAPIV3Local.ManagerMoods.Mood>

Scopes

homey.mood

HTTP

PUT /api/manager/moods/mood/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`mood`	object	In `body`
`name`	string <optional>
`devices`	object <optional>
`preset`	string <optional>
}
}

Returns

Promise.<HomeyAPIV3Local.ManagerMoods.Mood>

Events

mood.create

.on('mood.create')

Parameters

Name	Type	Description
`mood`	HomeyAPIV3Local.ManagerMoods.Mood

mood.delete

.on('mood.delete')

Parameters

Name	Type	Description
`mood`	HomeyAPIV3Local.ManagerMoods.Mood

mood.update

.on('mood.update')

Parameters

Name	Type	Description
`mood`	HomeyAPIV3Local.ManagerMoods.Mood