ManagerDashboards - Homey Web API

Access this instance at HomeyAPIV3Cloud.dashboards.

Extends

HomeyAPIV3.ManagerDashboards

Classes

Instance Methods

createDashboard

(async) createDashboard(opts): Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

Scopes

homey.dashboard

HTTP

POST /api/manager/dashboards/dashboard

Parameters

Name	Type	Description
`opts`	object
`dashboard`	object	In `body`
`name`	string
`columns`	array
}
}

Returns

Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

deleteDashboard

(async) deleteDashboard(opts)

Scopes

homey.dashboard

HTTP

DELETE /api/manager/dashboards/dashboard/:id

Parameters

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

getAppWidget

(async) getAppWidget(opts): Promise.<HomeyAPIV3Cloud.ManagerDashboards.AppWidget>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/appwidget/:id

Parameters

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

Returns

Promise.<HomeyAPIV3Cloud.ManagerDashboards.AppWidget>

getAppWidgetAutocomplete

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

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/appwidget/:id/autocomplete

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`settingId`	string	In `query`
`query`	string	In `query`
`settings`	object <optional>	In `query`
}

Returns

Promise.<any>

getAppWidgets

(async) getAppWidgets(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.AppWidget>>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/appwidget

Returns

Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.AppWidget>>

getDashboard

(async) getDashboard(opts): Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/dashboard/:id

Parameters

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

Returns

Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

getDashboards

(async) getDashboards(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.Dashboard>>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/dashboard

Returns

Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.Dashboard>>

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/dashboards/state

Returns

Promise.<any>

getWidgetStore

(async) getWidgetStore(opts): Promise.<HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/widgetstore/:id

Parameters

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

Returns

Promise.<HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>

getWidgetStoreState

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

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/widgetstore/:id/state

Parameters

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

Returns

Promise.<any>

getWidgetStores

(async) getWidgetStores(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>>

Scopes

homey.dashboard.readonly

HTTP

GET /api/manager/dashboards/widgetstore

Returns

Promise.<Object.<string, HomeyAPIV3Cloud.ManagerDashboards.WidgetStore>>

setWidgetStoreState

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

Scopes

homey.dashboard.readonly

HTTP

POST /api/manager/dashboards/widgetstore/:id/state

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`state`	object	In `body`
`replace`	boolean <optional>	In `body`
}

Returns

Promise.<any>

updateDashboard

(async) updateDashboard(opts): Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

Scopes

homey.dashboard

HTTP

PUT /api/manager/dashboards/dashboard/:id

Parameters

Name	Type	Description
`opts`	object
`id`	string	In `path`
`dashboard`	object	In `body`
`name`	string <optional>
`columns`	array <optional>
}
}

Returns

Promise.<HomeyAPIV3Cloud.ManagerDashboards.Dashboard>

Events

appwidget.create

.on('appwidget.create')

Parameters

Name	Type	Description
`appwidget`	HomeyAPIV3Cloud.ManagerDashboards.AppWidget

appwidget.delete

.on('appwidget.delete')

Parameters

Name	Type	Description
`appwidget`	HomeyAPIV3Cloud.ManagerDashboards.AppWidget

appwidget.update

.on('appwidget.update')

Parameters

Name	Type	Description
`appwidget`	HomeyAPIV3Cloud.ManagerDashboards.AppWidget

dashboard.create

.on('dashboard.create')

Parameters

Name	Type	Description
`dashboard`	HomeyAPIV3Cloud.ManagerDashboards.Dashboard

dashboard.delete

.on('dashboard.delete')

Parameters

Name	Type	Description
`dashboard`	HomeyAPIV3Cloud.ManagerDashboards.Dashboard

dashboard.update

.on('dashboard.update')

Parameters

Name	Type	Description
`dashboard`	HomeyAPIV3Cloud.ManagerDashboards.Dashboard

widgetstore.create

.on('widgetstore.create')

Parameters

Name	Type	Description
`widgetstore`	HomeyAPIV3Cloud.ManagerDashboards.WidgetStore

widgetstore.delete

.on('widgetstore.delete')

Parameters

Name	Type	Description
`widgetstore`	HomeyAPIV3Cloud.ManagerDashboards.WidgetStore

widgetstore.update

.on('widgetstore.update')

Parameters

Name	Type	Description
`widgetstore`	HomeyAPIV3Cloud.ManagerDashboards.WidgetStore