Access this instance at HomeyAPIV3Cloud.apps.
Extends
Classes
Methods
connect
(async) connect(): Promise.<void>Connect to the realtime namespace.
Returns
Promise.<void>
disconnect
(async) disconnect(): Promise.<void>Disconnect from the realtime namespace.
Returns
Promise.<void>
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 | |
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerApps.App>
getApps
(async) getApps(): Promise.<HomeyAPIV3Cloud.ManagerApps.App>Scopes
homey.app.readonly
HTTP
GET /api/manager/apps/app
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 | |
id
|
string | |
|
|
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 | |
|
|
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 | |
message
|
string | |
|
|
Returns
Promise.<any>
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>
isConnected
isConnected(): BooleanIf this manager's namespace is connected to Socket.io.
Returns
Boolean
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
|
object | |
|
|
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>
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 |