ManagerApps

Access this instance at HomeyAPIV3Local.apps.

Extends

  • HomeyAPIV3.ManagerApps

Classes

Instance Methods

disableApp

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

Scopes

homey.app

HTTP

PUT /api/manager/apps/app/:id/disable

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

enableApp

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

Scopes

homey.app

HTTP

PUT /api/manager/apps/app/:id/enable

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

getApp

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

Scopes

homey.app.readonly

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

Returns

getAppLocales

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

Scopes

homey.app.readonly

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

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
id
string
}

Returns

Promise.<any>

getAppSettings

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

Scopes

homey.app.control

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

Returns

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
message
string
}

Returns

Promise.<any>

getAppUsage

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

Scopes

homey.app.readonly

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

Returns

Promise.<any>

getApps

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

Scopes

homey.app.readonly

HTTP

GET /api/manager/apps/app

Returns

Promise.<Object.<string, HomeyAPIV3Local.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
channel
string <optional>
}

Returns

Promise.<any>

restartApp

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

Scopes

homey.app

HTTP

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

Parameters

Name Type Description
opts
object
id
string
}

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
id
string
value
*
}

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
}

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
id
string
}

Returns

Promise.<any>

updateApp

(async) updateApp(opts): Promise.<HomeyAPIV3Local.ManagerApps.App>

Scopes

homey.app

HTTP

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

Parameters

Name Type Description
opts
object
id
string
app
object
autoupdate
boolean <optional>
}
}

Returns

Events

app.create

.on('app.create')

Parameters

Name Type Description
app
HomeyAPIV3Local.ManagerApps.App

app.delete

.on('app.delete')

Parameters

Name Type Description
app
HomeyAPIV3Local.ManagerApps.App

app.update

.on('app.update')

Parameters

Name Type Description
app
HomeyAPIV3Local.ManagerApps.App

appsettings.create

.on('appsettings.create')

Parameters

Name Type Description
appsettings
HomeyAPIV3Local.ManagerApps.AppSettings

appsettings.delete

.on('appsettings.delete')

Parameters

Name Type Description
appsettings
HomeyAPIV3Local.ManagerApps.AppSettings

appsettings.update

.on('appsettings.update')

Parameters

Name Type Description
appsettings
HomeyAPIV3Local.ManagerApps.AppSettings