ManagerDevkit

Access this instance at HomeyAPIV3Local.devkit.

Extends

  • HomeyAPIV3.ManagerDevkit

Instance Methods

getAppStdOut

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

Scopes

homey.app

HTTP

GET /api/manager/devkit/std/:session

Parameters

Name Type Description
opts
object
session
string
}

Returns

Promise.<any>

getState

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

Scopes

homey.system.readonly

HTTP

GET /api/manager/devkit/state

Returns

Promise.<any>

installApp

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

Scopes

homey.app

HTTP

POST /api/manager/devkit/app

Parameters

Name Type Description
opts
object
manifest
object
clean
boolean <optional>
}

Returns

Promise.<any>

runApp

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

Upload & run an app on Homey Pro.

Parameters

Name Type Description
opts
Object
app
ReadableStream

A .tar.gz filestream.

env
Object

Environment variables.

debug
Boolean

Enable debug mode.

clean
Boolean

Purge all app settings before running the app.

}

Returns

Promise.<any>

stopApp

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

Scopes

homey.app

HTTP

DELETE /api/manager/devkit/:session

Parameters

Name Type Description
opts
object
session
string
}

Returns

Promise.<any>

uninstallApp

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

Scopes

homey.app

HTTP

DELETE /api/manager/devkit/app/:sessionId

Parameters

Name Type Description
opts
object
sessionId
string
}

Returns

Promise.<any>