HomeyAPI~ManagerImages

Methods

async getImages(optsopt) → {Object.<string, HomeyAPI.ManagerImages.Image>}

Required OAuth scopes:
- homey.device

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

async getImage(optsopt) → {HomeyAPI.ManagerImages.Image}

Required OAuth scopes:
- homey.device

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

destroy()

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

Events

image.create

Fired when a managed Image is created
Parameters:
Name Type Description
image HomeyAPI.ManagerImages.Image The affected Image

image.update

Fired when a managed Image is changed
Parameters:
Name Type Description
image HomeyAPI.ManagerImages.Image The affected Image

image.delete

Fired when a managed Image has been deleted
Parameters:
Name Type Description
image HomeyAPI.ManagerImages.Image The affected Image

Classes

Error

Image