ManagerApps - Homey Web API

Access this instance at HomeyAPIV3Cloud.apps.

Extends

HomeyAPIV3.ManagerApps

Classes

Instance Methods

getApp

(async) getApp(opts): Promise.<HomeyAPIV3Cloud.ManagerApps.App>

Scopes

homey.app.readonly

HTTP

GET /api/manager/apps/app/:id

Parameters

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

Returns

Promise.<HomeyAPIV3Cloud.ManagerApps.App>

getAppSetting

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

Scopes

homey.app.control

HTTP

GET /api/manager/apps/app/:id/setting/:name

Parameters

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

Returns

Promise.<any>

getAppSettings

(async) getAppSettings(opts): Promise.<HomeyAPIV3Cloud.ManagerApps.AppSettings>

Scopes

homey.app.control

HTTP

GET /api/manager/apps/app/:id/setting

Parameters

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

Returns

Promise.<HomeyAPIV3Cloud.ManagerApps.AppSettings>

getAppStd

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

Scopes

homey.app.readonly

HTTP

POST /api/manager/apps/app/:id/crashlog

Parameters

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

Returns

Promise.<any>

getApps

(async) getApps(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerApps.App>>

Scopes

homey.app.readonly

HTTP

GET /api/manager/apps/app

Returns

Promise.<Object.<string, HomeyAPIV3Cloud.ManagerApps.App>>

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/apps/state

Returns

Promise.<any>

installFromAppStore

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

Scopes

homey.app

HTTP

POST /api/manager/apps/store

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `body`
`channel`	string <optional>	In `body`
}

Returns

Promise.<any>

setAppSetting

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

Scopes

homey.app.control

HTTP

PUT /api/manager/apps/app/:id/setting/:name

Parameters

Name	Type	Description
`opts`	object
`name`	string	In `path`
`id`	string	In `path`
`value`	*	In `body`
}

Returns

Promise.<any>

uninstallApp

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

Scopes

homey.app

HTTP

DELETE /api/manager/apps/app/:id

Parameters

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

Returns

Promise.<any>

unsetAppSetting

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

Scopes

homey.app.control

HTTP

DELETE /api/manager/apps/app/:id/setting/:name

Parameters

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

Returns

Promise.<any>

Events

app.create

.on('app.create')

Parameters

Name	Type	Description
`app`	HomeyAPIV3Cloud.ManagerApps.App

app.delete

.on('app.delete')

Parameters

Name	Type	Description
`app`	HomeyAPIV3Cloud.ManagerApps.App

app.update

.on('app.update')

Parameters

Name	Type	Description
`app`	HomeyAPIV3Cloud.ManagerApps.App

appsettings.create

.on('appsettings.create')

Parameters

Name	Type	Description
`appsettings`	HomeyAPIV3Cloud.ManagerApps.AppSettings

appsettings.delete

.on('appsettings.delete')

Parameters

Name	Type	Description
`appsettings`	HomeyAPIV3Cloud.ManagerApps.AppSettings

appsettings.update

.on('appsettings.update')

Parameters

Name	Type	Description
`appsettings`	HomeyAPIV3Cloud.ManagerApps.AppSettings