HomeyAPI~ManagerApps.App

Properties:
Name Type Description
enabled boolean
autoupdate boolean
id string
sdk number (1 | 2 | 3)
name string
origin string ("appstore" | "devkit_run" | "devkit_install" | "unknown")
channel string ("stable" | "beta" | "alpha")
version string
compatibility string
icon string
iconObj object
Properties
Name Type Description
id string
url string
author object
Properties
Name Type Description
name string
email string
permissions Array.<string>
images object
Properties
Name Type Description
small string
large string
session string
ready boolean
state string ("stopped" | "stopping" | "starting" | "running")
crashed boolean
crashedMessage string
exitCode number
exitSignal string
exitCount number
settings boolean
brandColor string
hasDrivers boolean
usage object
Properties
Name Type Description
cpu number
mem number
updateAvailable object
Properties
Name Type Description
version string
permissions Array.<string>

Methods

async apiGet(path, queryParametersopt) → {object}

Sends an API HTTP GET call to this App
Parameters:
Name Type Attributes Description
path string The endpoint to make the call to
queryParameters object <optional>
 The HTTP query parameters
Returns:
object - the API response

async apiPut(path, bodyopt, queryParametersopt) → {object}

Sends an API HTTP PUT call to this App
Parameters:
Name Type Attributes Description
path string The endpoint to make the call to
body object <optional>
 The HTTP body
queryParameters object <optional>
 The HTTP query parameters
Returns:
object - the API response

async apiPost(path, bodyopt, queryParametersopt) → {object}

Sends an API HTTP POST call to this App
Parameters:
Name Type Attributes Description
path string The endpoint to make the call to
body object <optional>
 The HTTP body
queryParameters object <optional>
 The HTTP query parameters
Returns:
object - the API response

async apiDelete(path, bodyopt, queryParametersopt) → {object}

Sends an API HTTP DELETE call to this App
Parameters:
Name Type Attributes Description
path string The endpoint to make the call to
body object <optional>
 The HTTP body
queryParameters object <optional>
 The HTTP query parameters
Returns:
object - the API response

Events

$update

Fires when this instance has been updated.
Parameters:
Name Type Description
self this A self-reference

$delete

Fires when this instance has been deleted. After this event has fired, all listeners will be removed.