HomeyAPI~ManagerReminder

Methods

async getReminders(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.reminder.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Returns:
Promise.<void> - Successful response

async createReminder(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.reminder

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
reminder object
Returns:
Promise.<void> - Successful response

async getReminder(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.reminder.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<void> - Successful response

async updateReminder(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.reminder

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
reminder object
Returns:
Promise.<void> - Successful response

async deleteReminder(optsopt) → {Promise.<void>}

Required OAuth scopes:
- homey.reminder

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<void> - Successful response

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