ManagerAlarms

Access this instance at HomeyAPIV2.alarms.

Extends

Classes

Methods

connect

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

Connect to the realtime 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
*
}

Returns

deleteAlarm

(async) deleteAlarm(opts)

Scopes

homey.alarm

HTTP

DELETE /api/manager/alarms/alarm/:id

Parameters

Name Type Description
opts
object
id
string
}

disconnect

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

Disconnect from the realtime namespace.

Returns

Promise.<void>

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
}

Returns

getAlarms

(async) getAlarms(): Promise.<HomeyAPIV2.ManagerAlarms.Alarm>

Scopes

homey.alarm.readonly

HTTP

GET /api/manager/alarms/alarm

Returns

isConnected

isConnected(): Boolean

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

Returns

Boolean

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
alarm
*
}

Returns

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