Access this instance at HomeyAPIV3Local.alarms.
Extends
- HomeyAPIV3.ManagerAlarms
Classes
Instance Methods
createAlarm
(async) createAlarm(opts): Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>Scopes
homey.alarm
HTTP
POST /api/manager/alarms/alarm
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
alarm
|
object | |
name
|
string
<optional> |
|
time
|
string
<optional> |
|
enabled
|
boolean
<optional> |
|
repetition
|
object
<optional> |
|
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>
deleteAlarm
(async) deleteAlarm(opts)Scopes
homey.alarm
HTTP
DELETE /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
|
|
getAlarm
(async) getAlarm(opts): Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>Scopes
homey.alarm.readonly
HTTP
GET /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
|
|
Returns
Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>
getAlarms
(async) getAlarms(): Promise.<Object.<string, HomeyAPIV3Local.ManagerAlarms.Alarm>>Scopes
homey.alarm.readonly
HTTP
GET /api/manager/alarms/alarm
Returns
Promise.<Object.<string, HomeyAPIV3Local.ManagerAlarms.Alarm>>
updateAlarm
(async) updateAlarm(opts): Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>Scopes
homey.alarm
HTTP
PUT /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
alarm
|
object | |
name
|
string
<optional> |
|
time
|
string
<optional> |
|
enabled
|
boolean
<optional> |
|
repetition
|
object
<optional> |
|
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Local.ManagerAlarms.Alarm>
Events
alarm.create
.on('alarm.create')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV3Local.ManagerAlarms.Alarm |
alarm.delete
.on('alarm.delete')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV3Local.ManagerAlarms.Alarm |
alarm.update
.on('alarm.update')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV3Local.ManagerAlarms.Alarm |