ApiApp

homey.api_app

The API of another App on Homey. When registered, realtime events sent to this app are fired on the instance.

This class must not be initialized by the developer, but is instantiated when starting the app.

Ancestors

  • Api
  • homey.util.event_emitter.EventEmitter
  • typing.Generic

Methods

get_installed

async def get_installed(self) ‑> bool

Check whether the app is installed, enabled and running.

get_version

async def get_version(self) ‑> str

Get the app's installed version.

on_install

def on_install(self, f: Callable[[], None]) ‑> Self

The install event is fired when the other app is installed.

Args

NameTypeDescription
f Callable[[], None] A callback that receives no data.

on_uninstall

def on_uninstall(self, f: Callable[[], None]) ‑> Self

The uninstall event is fired when the other app is uninstalled.

Args

NameTypeDescription
f Callable[[], None] A callback that receives no data.

Inherited members