HomeyAPI~ManagerReminder

Methods

async getReminders(optsopt)

Required OAuth scopes:
- homey.reminder.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters

async createReminder(optsopt)

Required OAuth scopes:
- homey.reminder

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
reminder object

async getReminder(optsopt)

Required OAuth scopes:
- homey.reminder.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string

async updateReminder(optsopt)

Required OAuth scopes:
- homey.reminder

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
reminder object

async deleteReminder(optsopt)

Required OAuth scopes:
- homey.reminder

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

reminder.create

Fired when a managed Reminder is created
Parameters:
Name Type Description
reminder HomeyAPI.ManagerReminder.Reminder The affected Reminder

reminder.update

Fired when a managed Reminder is changed
Parameters:
Name Type Description
reminder HomeyAPI.ManagerReminder.Reminder The affected Reminder

reminder.delete

Fired when a managed Reminder has been deleted
Parameters:
Name Type Description
reminder HomeyAPI.ManagerReminder.Reminder The affected Reminder

Classes

Error

Reminder