Access this instance at HomeyAPIV2.alarms.
Extends
Classes
Instance Properties
homey
homey: HomeyAPIV3uri
uri: StringThe 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>
createAlarm
(async) createAlarm(opts): Promise.<HomeyAPIV2.ManagerAlarms.Alarm>Scopes
homey.alarm
HTTP
POST /api/manager/alarms/alarm
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
alarm
|
* | In |
|
|
Returns
Promise.<HomeyAPIV2.ManagerAlarms.Alarm>
deleteAlarm
(async) deleteAlarm(opts)Scopes
homey.alarm
HTTP
DELETE /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
|
|
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> |
getAlarm
(async) getAlarm(opts): Promise.<HomeyAPIV2.ManagerAlarms.Alarm>Scopes
homey.alarm.readonly
HTTP
GET /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
|
|
Returns
Promise.<HomeyAPIV2.ManagerAlarms.Alarm>
getAlarms
(async) getAlarms(): Promise.<Object.<string, HomeyAPIV2.ManagerAlarms.Alarm>>Scopes
homey.alarm.readonly
HTTP
GET /api/manager/alarms/alarm
Returns
Promise.<Object.<string, HomeyAPIV2.ManagerAlarms.Alarm>>
isConnected
isConnected(): BooleanIf 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(eventopt)Parameters
| Name | Type | Description |
|---|---|---|
event
|
string
<optional> |
removeListener
removeListener(event, callback)Shortcut to EventEmitter#off
Parameters
| Name | Type | Description |
|---|---|---|
event
|
string | |
callback
|
function |
updateAlarm
(async) updateAlarm(opts): Promise.<HomeyAPIV2.ManagerAlarms.Alarm>Scopes
homey.alarm
HTTP
PUT /api/manager/alarms/alarm/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | In |
alarm
|
* | In |
|
|
Returns
Promise.<HomeyAPIV2.ManagerAlarms.Alarm>
Events
alarm.create
.on('alarm.create')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV2.ManagerAlarms.Alarm |
alarm.delete
.on('alarm.delete')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV2.ManagerAlarms.Alarm |
alarm.update
.on('alarm.update')Parameters
| Name | Type | Description |
|---|---|---|
alarm
|
HomeyAPIV2.ManagerAlarms.Alarm |