HomeyAPI~ManagerNotifications

Methods

async getNotifications(optsopt) → {Object.<string, HomeyAPI.ManagerNotifications.Notification>}

Required OAuth scopes:
- homey.notifications.readonly

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
filter HomeyAPI.ManagerNotifications.Notification <optional>
A response filter (Using a filter will bypass all caches, use sparingely)
Returns:
Object.<string, HomeyAPI.ManagerNotifications.Notification> - Successful response

async getNotification(optsopt) → {HomeyAPI.ManagerNotifications.Notification}

Required OAuth scopes:
- homey.notifications.readonly

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

async deleteNotification(optsopt)

Required OAuth scopes:
- homey.notifications

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

async setNotificationRead(optsopt)

Required OAuth scopes:
- homey.notifications.readonly

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

async deleteNotifications(optsopt)

Required OAuth scopes:
- homey.notifications

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

async getOwners(optsopt)

Required OAuth scopes:
- homey.notifications.readonly

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

async setOwnerEnabled(optsopt)

Required OAuth scopes:
- homey.notifications

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
uri string
enabled boolean

async setOwnerPush(optsopt)

Required OAuth scopes:
- homey.notifications

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
uri string
push boolean

destroy()

Unsubscribes to realtime events, clear all caches, and remove all event listeners for this manager and it's managed objects

Events

notification.create

Fired when a managed Notification is created
Parameters:
Name Type Description
notification HomeyAPI.ManagerNotifications.Notification The affected Notification

notification.update

Fired when a managed Notification is changed
Parameters:
Name Type Description
notification HomeyAPI.ManagerNotifications.Notification The affected Notification

notification.delete

Fired when a managed Notification has been deleted
Parameters:
Name Type Description
notification HomeyAPI.ManagerNotifications.Notification The affected Notification

Classes

Error

Notification