- Since:
- 1.3.0
Methods
-
async getAlarms(optsopt) → {Object.<string, HomeyAPI.ManagerAlarms.Alarm>}
-
Required OAuth scopes:
- homey.alarm.readonly
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Attributes Description filter
HomeyAPI.ManagerAlarms.Alarm <optional>
A response filter (Using a filter will bypass all caches, use sparingely) Returns:
Object.<string, HomeyAPI.ManagerAlarms.Alarm> - Successful response -
async createAlarm(optsopt)
-
Required OAuth scopes:
- homey.alarm
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description alarm
HomeyAPI.ManagerAlarms.Alarm -
async getAlarm(optsopt) → {HomeyAPI.ManagerAlarms.Alarm}
-
Required OAuth scopes:
- homey.alarm.readonly
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string Returns:
HomeyAPI.ManagerAlarms.Alarm - Successful response -
async updateAlarm(optsopt)
-
Required OAuth scopes:
- homey.alarm
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string alarm
HomeyAPI.ManagerAlarms.Alarm -
async deleteAlarm(optsopt)
-
Required OAuth scopes:
- homey.alarm
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string -
destroy()
-
Unsubscribes to realtime events, clear all caches, and remove all event listeners for this manager and it's managed objects
Events
-
alarm.create
-
Fired when a managed Alarm is created
Parameters:
Name Type Description alarm
HomeyAPI.ManagerAlarms.Alarm The affected Alarm -
alarm.update
-
Fired when a managed Alarm is changed
Parameters:
Name Type Description alarm
HomeyAPI.ManagerAlarms.Alarm The affected Alarm -
alarm.delete
-
Fired when a managed Alarm has been deleted
Parameters:
Name Type Description alarm
HomeyAPI.ManagerAlarms.Alarm The affected Alarm