HomeyAPI~ManagerApps

Since:
  • 1.0.0

Methods

async getApps(optsopt) → {Promise.<Object.<string, HomeyAPI.ManagerApps.App>>}

Required OAuth scopes:
- homey.app.readonly

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

async getApp(optsopt) → {Promise.<HomeyAPI.ManagerApps.App>}

Required OAuth scopes:
- homey.app.readonly

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app.readonly

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

async getAppSettings(optsopt) → {Promise.<object>}

Required OAuth scopes:
- homey.app.control

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Description
id string
Returns:
Promise.<object> - A key-value object with app settings

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

Required OAuth scopes:
- homey.app.control

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

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

Required OAuth scopes:
- homey.app.control

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

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

Required OAuth scopes:
- homey.app.control

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app

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

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

Required OAuth scopes:
- homey.app.readonly

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

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

Required OAuth scopes:
- homey.app

Parameters:
Name Type Attributes Description
opts object <optional>
Named parameters
Properties
Name Type Attributes Description
id string
channel string <optional>
("stable" | "beta" | "alpha")
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

app.create

Fired when a managed App is created
Parameters:
Name Type Description
app HomeyAPI.ManagerApps.App The affected App

app.update

Fired when a managed App is changed
Parameters:
Name Type Description
app HomeyAPI.ManagerApps.App The affected App

app.delete

Fired when a managed App has been deleted
Parameters:
Name Type Description
app HomeyAPI.ManagerApps.App The affected App

Classes

Error

App