ManagerNotifications - Homey Web API

Access this instance at HomeyAPIV3Local.notifications.

Extends

HomeyAPIV3.ManagerNotifications

Classes

Notification

Instance Methods

deleteNotification

(async) deleteNotification(opts)

Scopes

homey.notifications

HTTP

DELETE /api/manager/notifications/notification/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
}

deleteNotifications

(async) deleteNotifications(opts): Promise.<any>

Scopes

homey.notifications

HTTP

DELETE /api/manager/notifications/notification

Parameters

Name	Type	Description
`opts`	object
`ownerUri`	string <optional>	In `query`
}

Returns

Promise.<any>

getNotifications

(async) getNotifications(): Promise.<Object.<string, HomeyAPIV3Local.ManagerNotifications.Notification>>

Scopes

homey.notifications.readonly

HTTP

GET /api/manager/notifications/notification

Returns

Promise.<Object.<string, HomeyAPIV3Local.ManagerNotifications.Notification>>

getOwners

(async) getOwners(): Promise.<any>

Scopes

homey.notifications.readonly

HTTP

GET /api/manager/notifications/owner

Returns

Promise.<any>

getState

(async) getState(): Promise.<any>

Scopes

homey.system.readonly

HTTP

GET /api/manager/notifications/state

Returns

Promise.<any>

setOwnerEnabled

(async) setOwnerEnabled(opts): Promise.<any>

Scopes

homey.notifications

HTTP

PUT /api/manager/notifications/owner/:uri/enabled

Parameters

Name	Type	Description
`opts`	object
`uri`	string	In `path`
`enabled`	boolean	In `body`
}

Returns

Promise.<any>

setOwnerPush

(async) setOwnerPush(opts): Promise.<any>

Scopes

homey.notifications

HTTP

PUT /api/manager/notifications/owner/:uri/push

Parameters

Name	Type	Description
`opts`	object
`uri`	string	In `path`
`push`	boolean	In `body`
}

Returns

Promise.<any>

Events

notification.create

.on('notification.create')

Parameters

Name	Type	Description
`notification`	HomeyAPIV3Local.ManagerNotifications.Notification

notification.delete

.on('notification.delete')

Parameters

Name	Type	Description
`notification`	HomeyAPIV3Local.ManagerNotifications.Notification

notification.update

.on('notification.update')

Parameters

Name	Type	Description
`notification`	HomeyAPIV3Local.ManagerNotifications.Notification
`info`	object
`newValues`	object	An object with only the new values of the notification
`oldValues`	object	An object with only the old values of the notification
`changedKeys`	Array.<string>	An array of keys of the properties that have changed
}